{"id":29356823,"url":"https://github.com/butterdebugger/trufflebyte","last_synced_at":"2025-07-31T06:37:18.381Z","repository":{"id":264307320,"uuid":"887330099","full_name":"ButterDebugger/TruffleByte","owner":"ButterDebugger","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-01T18:29:38.000Z","size":118,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-09T05:07:31.115Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ButterDebugger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-12T15:00:42.000Z","updated_at":"2025-07-01T18:29:54.000Z","dependencies_parsed_at":"2025-05-05T18:42:39.391Z","dependency_job_id":"a90d0b85-4f43-43cc-bed6-95a29751f0f3","html_url":"https://github.com/ButterDebugger/TruffleByte","commit_stats":null,"previous_names":["butterdebugger/jsbin"],"tags_count":0,"template":false,"template_full_name":"ButterDebugger/deno-jsr-template","purl":"pkg:github/ButterDebugger/TruffleByte","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterDebugger%2FTruffleByte","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterDebugger%2FTruffleByte/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterDebugger%2FTruffleByte/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterDebugger%2FTruffleByte/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ButterDebugger","download_url":"https://codeload.github.com/ButterDebugger/TruffleByte/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ButterDebugger%2FTruffleByte/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267999427,"owners_count":24178776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-09T05:07:28.775Z","updated_at":"2025-07-31T06:37:18.309Z","avatar_url":"https://github.com/ButterDebugger.png","language":"TypeScript","readme":"# TruffleByte\n\n[![JSR](https://jsr.io/badges/@debutter/trufflebyte)](https://jsr.io/@debutter/trufflebyte)\n[![JSR Score](https://jsr.io/badges/@debutter/trufflebyte/score)](https://jsr.io/@debutter/trufflebyte)\n\nA simple and lightweight library designed to provide efficient binary\nserialization for JavaScript objects. This makes it easy to encode JavaScript\ndata structures into compact binary formats, saving space and improving\ntransmission speeds.\n\n## Installation\n\nFor Node.js:\n\n```bash\nnpx jsr add @debutter/trufflebyte\n```\n\nFor Deno:\n\n```bash\ndeno add jsr:@debutter/trufflebyte\n```\n\nFor Browsers:\n\n```javascript\nimport * as TruffleByte from \"https://esm.sh/jsr/@debutter/trufflebyte@VERSION\";\n```\n\n## Usage\n\nExample usage for encoding and decoding objects:\n\n```javascript\nimport { decode, encode } from \"@debutter/trufflebyte\";\n\nconst data = {\n\tmessage: \"Hello, world!\"\n};\n\n// Encode to binary\nconst encoded = encode(data);\n\n// Decode from binary\nconst decoded = decode(encoded);\n\nconsole.log(decoded); // { message: \"Hello, world!\" }\n```\n\n## Supported Data Types\n\nTruffleByte supports a wide range of JavaScript data types, including:\n\n-   Objects\n-   Arrays\n-   Strings\n-   Numbers\n-   BigInts\n-   Booleans\n-   Null\n-   Undefined\n-   Dates\n-   Sets\n-   Maps\n-   Regular Expressions\n-   URLs\n\n## Extensibility\n\nTruffleByte is designed to be extensible, allowing you to add support for custom data\ntypes. You can do this by creating your own transformers to handle specific data\ntypes.\n\n```javascript\nimport { registerTransformer } from \"@debutter/trufflebyte\";\n\n// Define a custom transformer for a specific data type\nconst MyCustomTransformer = registerTransformer(0, {\n\tisApplicable: (value) =\u003e value instanceof MyCustomType,\n\tserialize: (encoder, value) =\u003e {\n\t\tencoder.write(/* Encode the value */);\n\t\t// ...\n\t},\n\tdeserialize: (decoder) =\u003e {\n\t\treturn new MyCustomType(/* Decode the value */);\n\t}\n});\n```\n\nAdditionally, you can also chain together other transformers to encode and\ndecode more complex data structures.\n\n```javascript\nimport { NumberTransformer, registerTransformer } from \"@debutter/trufflebyte\";\n\n// Define a custom transformer for a specific data type\nconst Vector2dTransformer = registerTransformer(0, {\n\tisApplicable: (value) =\u003e value instanceof Vector2d,\n\tserialize: (encoder, vector) =\u003e {\n\t\tencoder.chain(NumberTransformer, vector.x);\n\t\tencoder.chain(NumberTransformer, vector.y);\n\t},\n\tdeserialize: (decoder) =\u003e {\n\t\tconst x = decoder.chain(NumberTransformer);\n\t\tconst y = decoder.chain(NumberTransformer);\n\n\t\treturn new Vector2d(x, y);\n\t}\n});\n```\n\nNote that custom transformer tags ranging from 0 to 127 are reserved by this\nlibrary and are subject to being taken.\n\n# Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbutterdebugger%2Ftrufflebyte","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbutterdebugger%2Ftrufflebyte","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbutterdebugger%2Ftrufflebyte/lists"}