Claude Bot
6a2b35245a
docs: document comprehensive set of undocumented Bun APIs
...
This commit adds extensive documentation for previously undocumented APIs
across multiple categories:
**Utility APIs** (docs/api/utils.md):
- Bun.nanoseconds() - high-precision timing
- Bun.indexOfLine() - line boundary detection
- Bun.shellEscape() - shell injection prevention
- Bun.allocUnsafe() - unsafe memory allocation
- Bun.shrink() - memory optimization
- Bun.mmap() - memory-mapped file access
- Bun.resolve()/resolveSync() - module resolution
- Bun.unsafe namespace - low-level operations
- Bun.CSRF - CSRF token generation/verification
- Enhanced memory management APIs
**Compression APIs** (new docs/guides/util/zstd.md + utils.md):
- Bun.zstdCompress()/zstdCompressSync()
- Bun.zstdDecompress()/zstdDecompressSync()
- Performance comparisons and usage patterns
**Hashing APIs** (docs/api/hashing.md):
- Individual hash classes (MD4, MD5, SHA family)
- Instance methods (.update(), .digest())
- Static methods (.hash(), .byteLength)
- Security considerations for legacy algorithms
**Binary Data APIs** (docs/api/binary-data.md):
- Bun.CryptoHasher - hardware-accelerated hashing
- Streaming and performance optimization examples
**Shell APIs** (docs/runtime/shell.md):
- Bun.createParsedShellScript() - script parsing
- Bun.createShellInterpreter() - interpreter creation
**Macro APIs** (docs/bundler/macros.md):
- Bun.registerMacro() - internal macro registration
**Embedded Files** (docs/bundler/executables.md):
- Enhanced Bun.embeddedFiles documentation
- HTTP serving and access patterns
Total changes: 1,420+ lines of comprehensive documentation added
across 7 files, with practical examples, security considerations,
and performance guidance for all documented APIs.
🤖 Generated with [Claude Code](https://claude.ai/code )
Co-Authored-By: Claude <noreply@anthropic.com >
2025-08-28 21:09:43 +00:00
Joel Shepherd
13c5b0d9cb
Added rapidhash algorithm ( #20163 )
2025-06-03 03:34:35 -07:00
versecafe
6cb0d49afb
Implement Bun.hash.xxHash32|64() ( #16397 )
2025-01-15 00:54:44 -08:00
Jarred Sumner
d879f4370d
Update hashing.md
2024-11-09 02:27:50 -08:00
Jarred Sumner
ae6e23ab28
Update hashing.md
2024-11-09 02:25:18 -08:00
Jarred Sumner
7a9165555d
Update hashing.md
2024-11-09 02:19:24 -08:00
Jarred Sumner
af82a446df
Support hmac in Bun.CryptoHasher ( #14210 )
2024-09-27 23:33:22 -07:00
Meghan Denny
c7d7bc120a
node:crypto: add shake128 and shake256 ( #11134 )
2024-05-16 23:16:59 -07:00
Meghan Denny
e3689e7e83
node:crypto: add blake2b512, sha512-224, sha3-* ( #10383 )
...
* node:crypto: add blake2b512, sha512-224, sha3-*
* update submodule
* flesh out rest of api
* remove new bun.newCatchable
* add SHA512_224 to HashClasses
* remove SHA512_224 js class
* better allocation
* remove memcpy in path where buffer is provided to us
* add back benchmark
* move zig crypto things into specific struct
* Apply formatting changes
* centralize algorithm definitions into one spot
* rsa-256 was deleted
---------
Co-authored-by: Jarred Sumner <jarred@jarredsumner.com >
Co-authored-by: Jarred-Sumner <Jarred-Sumner@users.noreply.github.com >
2024-04-23 19:35:27 -07:00
Samual Norman
182d3f1567
Fix Bun.CryptoHasher missing argument in docs ( #4585 )
2023-09-08 09:32:36 -07:00
Colin McDonnell
5424ea3403
Doc updates for v1.0 ( #4485 )
...
* Remove v0.x messages
* Add windows section to Installatino
* update
* update
* Update
* Comment out windows
2023-09-07 10:09:09 -07:00
jhmaster
182e600eb7
Fix Bun.hash functions ( #4054 )
...
* fix `Bun.hash` functions to behave as expected
* update Bun.hash tests
* properly test the returned hash
* include murmur32v2
* update Bun.hash docs
* run fmt
2023-08-07 23:30:05 -07:00
Colin McDonnell
d265ed80d2
Docs for Bun.password and ws publish ( #3227 )
...
* Update websocket docs & jsdoc
* Document Bun.password
* Update hash encoding docs
* Fix typos
* Add info about user-specific data in ws
* Update outdated websocket jsdoc
* Replace usages of req.url
* Remove log
2023-06-06 23:50:43 -07:00
Colin McDonnell
9b6913e1a6
More/better docs for JSX, utils, binary data, streams, hashing, bun test, Bun.serve ( #3005 )
...
* WIP
* Updates
* Document deepEquals
* WIP
* Update typeS
* Update TLS docs for Bun.serve
* Update types for tls
* Draft binary data page. Add Streams page.
* Update test runner docs
* Add hashing, flesh out utils
* Grammar
* Update types
* Fix
* Add import.meta docs
* Tee
2023-05-29 11:49:51 -07:00
