{"id":21385692,"url":"https://github.com/devsargam/huffman-encoder-decoder","last_synced_at":"2025-03-16T12:13:25.684Z","repository":{"id":212128822,"uuid":"730779909","full_name":"devsargam/Huffman-Encoder-Decoder","owner":"devsargam","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-13T15:48:00.000Z","size":1284,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-22T23:43:54.620Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devsargam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-12-12T16:51:04.000Z","updated_at":"2023-12-19T08:30:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"36133ad5-5ada-4d86-b152-c746b610368d","html_url":"https://github.com/devsargam/Huffman-Encoder-Decoder","commit_stats":null,"previous_names":["devsargam/huffman-encoder-decoder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsargam%2FHuffman-Encoder-Decoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsargam%2FHuffman-Encoder-Decoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsargam%2FHuffman-Encoder-Decoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsargam%2FHuffman-Encoder-Decoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devsargam","download_url":"https://codeload.github.com/devsargam/Huffman-Encoder-Decoder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243864822,"owners_count":20360360,"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","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":"2024-11-22T11:50:29.002Z","updated_at":"2025-03-16T12:13:25.652Z","avatar_url":"https://github.com/devsargam.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\u003cimg height=\"150\" src=\"assets/logo.png\" /\u003e\u003cbr\u003eHuffman coding (TypeScript)\u003c/h1\u003e\n\nHuffman code is a particular type of optimal prefix code that is commonly used for lossless data compression. This is the implementation of the algorithm on TypeScript.\n\n## Installation\n\nClone this repository and install modules:\n\n```bash\ngit clone https://github.com/devsargam/Huffman-Encoder-Decoder.git\ncd Huffman-Encoder-Decoder\nnpm install\nnpm run dev(or build)\n```\n\n![](assets/split.png)\n\n## Usage\n\n\u003cb\u003eThe algorithm implementation is in the file /src/index.ts\u003c/b\u003e\n\nLet's encode and decode plain text!\n\n```typescript\nimport { getCodesFromText, encode, decode } from './huffman';\n\n/** ENCODING */\nlet text: string = 'abracadabra';\nlet encodedText: string = '';\n\nlet codes: Map\u003cstring, string\u003e = getCodesFromText(text); // Symbols codes\nlet encodedArray: Array\u003cany\u003e = encode(text, codes); // Get array of encoded symbols\n\nencodedText = encodedArray.join(''); // Encoded array to string. Equals 0101100...\n\n/** DECODING */\ntext = decode(encodedArray, codes); // Equals 'abracadabra'\n```\n\n![](assets/split.png)\n\n## APIs\n\n#### Encode text\n\n```typescript\nencode(text: string, codes: Map\u003cstring, string\u003e): Array\u003cstring\u003e\n```\n\n#### Decode text\n\n```typescript\ndecode(text: Array\u003cstring\u003e, codes: Map\u003cstring, string\u003e):string\n```\n\n#### Get symbols codes from text\n\n```typescript\ngetCodesFromText(text: string): Map\u003cstring, string\u003e\n```\n\n#### Get symbols frequency\n\n```typescript\ngetFrequency(text: string): Array\u003cany\u003e\n```\n\n#### Get Huffman Tree from frequency array\n\n```typescript\ngetTree(arr: Array\u003cany\u003e)\n```\n\n#### Get relative frequency array\n\n```typescript\ngetRelativeFrequency(arr: Array\u003cany\u003e): Array\u003cany\u003e\n```\n\n#### Get text entropy\n\n```typescript\ngetEntropyOfText(text: string): number\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsargam%2Fhuffman-encoder-decoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevsargam%2Fhuffman-encoder-decoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsargam%2Fhuffman-encoder-decoder/lists"}