├── .deepsource.toml ├── .eslintignore ├── .eslintrc ├── .github ├── dependabot.yml └── workflows │ └── main.yml ├── .gitignore ├── .npmignore ├── CODE_OF_CONDUCT.md ├── LICENSE ├── README.md ├── SECURITY.md ├── babelrc.test.js ├── jsdoc.json ├── package.json ├── src ├── Binary.js ├── BinaryArray.js ├── TextEncoder-polyfill.js ├── Types.js ├── decorators.js ├── index.js └── index.test.js └── yarn.lock /.deepsource.toml: -------------------------------------------------------------------------------- 1 | version = 1 2 | 3 | [[analyzers]] 4 | name = "javascript" 5 | enabled = true 6 | 7 | [[transformers]] 8 | name = "standardjs" 9 | enabled = true 10 | 11 | [[transformers]] 12 | name = "prettier" 13 | enabled = true -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | build/ 2 | dist/ 3 | doc/ 4 | coverage/ 5 | node_modules/ 6 | .snapshots/ 7 | *.min.js 8 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "parser": "babel-eslint", 3 | "extends": [ 4 | "standard", 5 | "plugin:prettier/recommended", 6 | "prettier" 7 | ], 8 | "env": { 9 | "node": true 10 | }, 11 | "parserOptions": { 12 | "ecmaVersion": 2020, 13 | "ecmaFeatures": { 14 | "legacyDecorators": true, 15 | "jsx": true 16 | } 17 | }, 18 | "rules": { 19 | "space-before-function-paren": 0, 20 | "import/export": 0 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "npm" 9 | directory: "/" 10 | schedule: 11 | interval: "daily" 12 | commit-message: 13 | prefix: "npm" 14 | include: "scope" 15 | 16 | - package-ecosystem: "github-actions" 17 | directory: "/" 18 | schedule: 19 | # Check for updates to GitHub Actions every weekday 20 | interval: "daily" 21 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: General Validity 2 | 3 | on: 4 | workflow_dispatch: 5 | push: 6 | branches: [ main ] 7 | paths-ignore: 8 | # Can we use '**.md' ? 9 | - 'README.md' 10 | - 'SECURITY.md' 11 | - 'CODE_OF_CONDUCT.md' 12 | - 'LICENSE' 13 | - '.gitignore' 14 | - '.npmignore' 15 | pull_request: 16 | branches: [ main ] 17 | 18 | jobs: 19 | 20 | test: 21 | runs-on: ubuntu-24.04 22 | strategy: 23 | matrix: 24 | node: [14] 25 | 26 | # Map a step output to a job output 27 | outputs: 28 | coverage: ${{ steps.coverage.outputs.coverage }} 29 | coverage-rounded-display: ${{ steps.coverage.outputs.coverage-rounded-display }} 30 | 31 | steps: 32 | - uses: actions/checkout@v4 33 | - uses: actions/setup-node@v4.4.0 34 | with: 35 | node-version: ${{ matrix.node }} 36 | 37 | - name: Cache node modules 38 | uses: actions/cache@v4 39 | with: 40 | path: | 41 | node_modules 42 | .yarn/cache 43 | key: ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('.github/workflows/*.yml') }} 44 | restore-keys: | 45 | ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }} 46 | ${{ runner.OS }}-build 47 | 48 | - name: yarn install 49 | run: yarn --color --immutable 50 | 51 | - name: test + coverage 52 | run: yarn test:unit 53 | 54 | # Coverage badges will be updated on any branch 55 | # and saved into a dedicated one 56 | - name: Check test coverage 57 | uses: johanvanhelden/gha-clover-test-coverage-check@v1 58 | id: coverage 59 | with: 60 | percentage: 50 61 | exit: 0 62 | rounded-precision: 2 63 | filename: "coverage/clover.xml" 64 | 65 | badge: 66 | 67 | # Only generate and publish if these conditions are met: 68 | # - The test step ended successfully 69 | # - One of these is met: 70 | # - This is a pull request event and the pull actor is the same as the repo owner 71 | # - This is a push event and the push event is on branch 'main' 72 | needs: test 73 | if: ${{ ( github.event_name == 'pull_request' && github.actor == github.repository_owner ) || github.ref == 'refs/heads/main' }} 74 | 75 | runs-on: ubuntu-latest 76 | 77 | steps: 78 | 79 | - name: Extract branch name 80 | run: | 81 | TMP_PULL_HEAD_REF="${{ github.head_ref }}" 82 | TMP_GITHUB_REF="${GITHUB_REF#refs/heads/}" 83 | EXPORT_VALUE="" 84 | if [ "${TMP_PULL_HEAD_REF}" != "" ] 85 | then 86 | EXPORT_VALUE="${TMP_PULL_HEAD_REF}" 87 | else 88 | EXPORT_VALUE="${TMP_GITHUB_REF}" 89 | fi 90 | echo "branch=${EXPORT_VALUE}" >> "${GITHUB_OUTPUT}" 91 | id: extract_branch 92 | 93 | - uses: actions/checkout@v4 94 | with: 95 | ref: badges 96 | 97 | # Use the output from the `coverage` step 98 | - name: Generate the badge SVG image 99 | uses: emibcn/badge-action@v2.0.3 100 | id: badge 101 | with: 102 | label: 'Coverage' 103 | status: ${{ needs.test.outputs.coverage-rounded-display }} 104 | color: ${{ 105 | needs.test.outputs.coverage > 90 && 'green' || 106 | needs.test.outputs.coverage > 80 && 'yellow,green' || 107 | needs.test.outputs.coverage > 70 && 'yellow' || 108 | needs.test.outputs.coverage > 60 && 'orange,yellow' || 109 | needs.test.outputs.coverage > 50 && 'orange' || 110 | needs.test.outputs.coverage > 40 && 'red,orange' || 111 | needs.test.outputs.coverage > 30 && 'red,red,orange' || 112 | needs.test.outputs.coverage > 20 && 'red,red,red,orange' || 113 | 'red' }} 114 | path: test-coverage.svg 115 | 116 | - name: Commit badge 117 | env: 118 | BRANCH: ${{ steps.extract_branch.outputs.branch }} 119 | FILE: 'test-coverage.svg' 120 | run: | 121 | git config --local user.email "action@github.com" 122 | git config --local user.name "GitHub Action" 123 | mkdir -p "${BRANCH}" 124 | mv "${FILE}" "${BRANCH}" 125 | git add "${BRANCH}/${FILE}" 126 | 127 | # Will give error if badge did not changed 128 | git commit -m "Add/Update badge" || true 129 | - name: Push badge commit 130 | uses: ad-m/github-push-action@master 131 | with: 132 | github_token: ${{ secrets.GITHUB_TOKEN }} 133 | branch: badges 134 | 135 | test-build: 136 | runs-on: ubuntu-24.04 137 | steps: 138 | - uses: actions/checkout@v4 139 | - uses: actions/setup-node@v4.4.0 140 | with: 141 | node-version: 14.x 142 | 143 | - name: Cache node modules 144 | uses: actions/cache@v4 145 | with: 146 | path: | 147 | node_modules 148 | .yarn/cache 149 | key: ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('.github/workflows/*.yml') }} 150 | restore-keys: | 151 | ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }} 152 | ${{ runner.OS }}-build 153 | 154 | - name: yarn install 155 | run: yarn --immutable 156 | 157 | - name: test build 158 | run: yarn test:build-test 159 | 160 | docs: 161 | runs-on: ubuntu-24.04 162 | needs: [test, test-build] 163 | if: ${{ ( github.event_name == 'pull_request' && github.event.pull_request.merged == true ) || github.ref == 'refs/heads/main' }} 164 | steps: 165 | - uses: actions/checkout@v4 166 | - uses: actions/setup-node@v4.4.0 167 | with: 168 | node-version: 14.x 169 | 170 | - name: Cache node modules 171 | uses: actions/cache@v4 172 | with: 173 | path: | 174 | node_modules 175 | .yarn/cache 176 | key: ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('.github/workflows/*.yml') }} 177 | restore-keys: | 178 | ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }} 179 | ${{ runner.OS }}-build 180 | 181 | - name: yarn install 182 | run: yarn --immutable 183 | 184 | - name: generate docs 185 | run: yarn mkdocs 186 | 187 | - name: Deploy to GitHub Pages 188 | if: success() 189 | uses: crazy-max/ghaction-github-pages@v4 190 | with: 191 | target_branch: gh-pages 192 | build_dir: doc 193 | env: 194 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 195 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Editors 2 | *~ 3 | .*.sw* 4 | 5 | # Built 6 | dist 7 | doc 8 | coverage 9 | 10 | # dependencies 11 | node_modules 12 | .pnp 13 | .pnp.js 14 | 15 | # Package managers logs 16 | npm-debug.log* 17 | yarn-debug.log* 18 | yarn-error.log* 19 | 20 | # Docker is only for dev 21 | Dockerfile 22 | docker-compose.yml 23 | start-ssh.sh 24 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | # Editors 2 | .*.sw* 3 | *~ 4 | 5 | # Repo 6 | SECURITY.md 7 | CODE_OF_CONDUCT.md 8 | .gitignore 9 | .git 10 | .github 11 | 12 | # NPM/Yarn stuff 13 | node_modules/ 14 | .npmrc 15 | npm-debug.log* 16 | yarn-debug.log* 17 | yarn-error.log* 18 | 19 | # Docker is only for dev 20 | Dockerfile 21 | docker-compose.yml 22 | start-ssh.sh 23 | 24 | # Development, test and build assets 25 | coverage 26 | doc 27 | babelrc.test.js 28 | jsdoc.json 29 | src/index.test.js 30 | src/TextEncoder-polyfill.js 31 | dist/index.test.js 32 | dist/TextEncoder-polyfill.js 33 | .eslint* 34 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | - Demonstrating empathy and kindness toward other people 21 | - Being respectful of differing opinions, viewpoints, and experiences 22 | - Giving and gracefully accepting constructive feedback 23 | - Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | - Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | - The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | - Trolling, insulting or derogatory comments, and personal or political attacks 33 | - Public or private harassment 34 | - Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | - Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | emibcn.github@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Coverage](https://raw.githubusercontent.com/emibcn/binary-object/badges/main/test-coverage.svg) 2 | [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) 3 | [![DeepSource](https://deepsource.io/gh/emibcn/binary-object.svg/?label=active+issues&show_trend=true&token=A5qLC8ie8rosf2uYf1MoGMRy)](https://deepsource.io/gh/emibcn/binary-object/?ref=repository-badge) 4 | 5 | # Binary Object 6 | 7 | Manage binary data with strictly typed JavaScript Object-oriented programming. 8 | 9 | ## Summary 10 | 11 | - [Install](#install) 12 | - [Usage](#usage) 13 | - [First: polyfill if needed](#first-polyfill-if-needed) 14 | - [Second: decorators or not](#second-decorators-or-not) 15 | - [API](#api) 16 | - [Examples](#examples) 17 | - [Memory owner](#memory-owner) 18 | - [Use cases](#use-cases) 19 | - [WebAssembly](#webassembly) 20 | - [Disable Garbage Collector (GC)](#disable-garbage-collector-gc) 21 | - [Workers API](#workers-api) 22 | - [Saving/restoring states](#savingrestoring-states) 23 | - [Accessing binary data files](#accessing-binary-data-files) 24 | - [Accessing binary APIs](#accessing-binary-apis) 25 | - [Develop backend DB APIs](#develop-backend-db-apis) 26 | - [See also](#see-also) 27 | 28 | ## Install 29 | 30 | With `npm`: 31 | 32 | ```shell 33 | npm install binary-object 34 | ``` 35 | 36 | With `yarn`: 37 | 38 | ```shell 39 | yarn add binary-object 40 | ``` 41 | 42 | ## Usage 43 | 44 | ### First: polyfill if needed 45 | 46 | This library uses `TextEncoder` and `TextDecoder` to transform text to and from binary data. These are JavaScript native functions, but Node lacks them. You need to polyfill them first: 47 | 48 | ```javascript 49 | if (!("TextEncoder" in global)) { 50 | import("util").then((nodeUtil) => { 51 | global.TextEncoder = nodeUtil.TextEncoder; 52 | global.TextDecoder = nodeUtil.TextDecoder; 53 | }); 54 | } 55 | ``` 56 | 57 | For this to work on Node >= 14, you need to install `util` first: 58 | 59 | ```shell 60 | npm install --save util 61 | ``` 62 | 63 | ### Second: decorators or not 64 | 65 | This library encourages the use of class member decorators, available in Typescript, but at a [stage 2 proposal](https://github.com/tc39/proposals#stage-2). To add it into your `Babel` configuration, you will need something like: 66 | 67 | ```json 68 | "plugins": [ 69 | "@babel/plugin-transform-runtime", 70 | [ "@babel/plugin-proposal-decorators", { "legacy": true } ], 71 | [ "@babel/plugin-proposal-class-properties", { "loose": true } ] 72 | ] 73 | ``` 74 | 75 | If you don't want to use decorators, you will need to use it like (not tested): 76 | 77 | ```javascript 78 | class MyBinaryClass extends Binary { 79 | /* Functions/logic/statics */ 80 | } 81 | Object.defineProperty( 82 | MyBinaryClass.prototype, 83 | "someMember", 84 | binary(Types.Float32), 85 | ); 86 | ``` 87 | 88 | ### API 89 | 90 | See autogenerated `jsdoc` API documentation at [this repo's GitHub Page](https://emibcn.github.io/binary-object). 91 | 92 | ### Examples 93 | 94 | ```javascript 95 | import { Binary, binary, Types } from "binary-object"; 96 | 97 | // Declare object shape 98 | class BinaryTest extends Binary { 99 | @binary(Types.Uint32) 100 | id = 0; 101 | @binary(Types.Float64) 102 | testFloat = 0; 103 | 104 | // Array of 10 low precision floating point numbers 105 | @binary(Types.Array(Types.Float32, 10)) 106 | testFloatArray; 107 | 108 | showId = () => console.log(`My id is ${this.id}`); 109 | } 110 | 111 | // Allocate memory 112 | const binTest = new ArrayBuffer(BinaryTest.binarySize); 113 | 114 | // Instantiate memory parser 115 | const proxyObject = new BinaryTest(binTest); 116 | 117 | // Use it 118 | proxyObject.id = 12345; 119 | proxyObject.testFloat = 7.8; 120 | 121 | expect(proxyObject.id).toBe(12345); 122 | expect(proxyObject.testFloat).toBe(7.8); 123 | ``` 124 | 125 | Accessing and modifying arrays and array elements also work: 126 | 127 | ```javascript 128 | const testArray = proxyObject.testFloatArray; 129 | 130 | // Iteratibility 131 | expect([...testArray]).toEqual(new Array(10).fill(0)); 132 | 133 | // Elements access and modification 134 | expect(testArray[0]).toBe(0); 135 | testArray[0] = 1; 136 | expect(testArray[0]).toBe(1); 137 | expect(testArray[1]).toBe(0); 138 | testArray[1] = 2; 139 | expect(testArray[0]).toBe(1); 140 | expect(testArray[1]).toBe(2); 141 | 142 | // Modify full array 143 | const newArr = [1, 0, 0, 0, 0, 0, 0, 0, 0, 1]; 144 | proxyObject.testFloatArray = newArr; 145 | expect([...testArray]).toEqual(newArr); 146 | ``` 147 | 148 | You can define padded arrays for better performance and, maybe, enforced by API: 149 | 150 | ```javascript 151 | const type = Types.Uint32; 152 | const length = 5; 153 | class BinaryPadTest extends Binary { 154 | @binary(Types.Uint8) 155 | someMemberAtTheBegining; 156 | 157 | // Here, `true` reffers to padding 158 | @binary(Types.Array(type, length, true)) 159 | testArray; 160 | 161 | @binary(Types.Uint8) 162 | someMemberAtTheEnd; 163 | } 164 | 165 | const binTest2 = new ArrayBuffer(BinaryPadTest.binarySize); 166 | const testObj = new BinaryPadTest(binTest2); 167 | 168 | // The first byte of someMemberAtTheBegining forces to consume 169 | // a full testArray element before it (for padding) 170 | const expectedSize = (length + 1) * type.bytes + 1; 171 | expect(BinaryPadTest.binarySize).toBe(expectedSize); 172 | expect(testObj.testArray).toBeInstanceOf(type.extractor); // Uint32Array 173 | ``` 174 | 175 | Object composition is also allowed: 176 | 177 | ```javascript 178 | class BinaryArrayOfNestedTest extends Binary { 179 | // Array of 3 BinaryTest objects 180 | @binary(Types.Array(Types.Struct(BinaryTest), 3)) 181 | testNested; 182 | 183 | get id() { 184 | return this.testNested[0].id; 185 | } 186 | set id(value) { 187 | this.testNested[0].id = value; 188 | return true; 189 | } 190 | 191 | @binary(Types.Uint32) 192 | someNumber = 0; 193 | 194 | showId = this.testNested[0].showId; 195 | } 196 | 197 | const binTest2 = new ArrayBuffer(BinaryArrayOfNestedTest.binarySize); 198 | const proxyNested = new BinaryArrayOfNestedTest(binTest2); 199 | ``` 200 | 201 | Object composition from different memory sources is also allowed: 202 | 203 | ```javascript 204 | class Position extends Binary { 205 | @binary(Types.Uint32) 206 | x; 207 | @binary(Types.Uint32) 208 | y; 209 | 210 | static testCollision(pos1, pos2) { 211 | ... 212 | } 213 | 214 | collision = (pos2) => this.constructor.testCollision(this, pos2); 215 | } 216 | 217 | class Player extends Binary { 218 | @binary( Types.Struct(Position) ) 219 | position; 220 | @binary(Types.Float64) 221 | life; 222 | 223 | // Non managed binary data (like pointers) 224 | bullets = []; 225 | } 226 | 227 | class Bullet extends Binary { 228 | @binary( Types.Struct(Position) ) 229 | position; 230 | @binary(Types.Float64) 231 | direction; 232 | } 233 | 234 | class Game { 235 | constructor() { 236 | // malloc for players 237 | this.binPlayers = new ArrayBuffer( Player.binarySize * 2 ); 238 | this.player1 = new Player( this.binPlayers ); 239 | this.player2 = new Player( this.binPlayers, Player.binarySize ); 240 | 241 | // malloc for bullets 242 | this.maxBullets = 100; 243 | this.binBullets = new ArrayBuffer( Bullet.binarySize * this.maxBullets ); 244 | 245 | // Optimize bullets by using a unique DataView for all of them 246 | this.dvBullets = new DataView(this.binBullets); 247 | 248 | // Half of the bullets for each player 249 | Bullets.arrayFactory( 250 | this.dvBullets, 251 | maxBullets / 2, 252 | 0, 253 | player1.bullets); 254 | Bullets.arrayFactory( 255 | this.dvBullets, 256 | maxBullets / 2, 257 | maxBullets / 2, 258 | player2.bullets); 259 | } 260 | 261 | // You can move Bullets using a parallel worker or a WASM code block 262 | 263 | // Sometimes, check if a bullet touched a victim 264 | testTouched(attacker, victim) { 265 | const {position: {collision}} = victim; 266 | const touched = attacker.bullets.some( ({position}) => collision(position) ); 267 | } 268 | } 269 | 270 | ``` 271 | 272 | Transform your binary data into a JSON string: 273 | 274 | ```javascript 275 | console.log(JSON.stringify(proxyNested)); 276 | ``` 277 | 278 | Assign data from JS objects: 279 | 280 | ```javascript 281 | proxyNested.testNested = { testFloatArray: [0, 0, 0, 0, 0, 0, 0, 0, 0, 1] }; 282 | expect([...proxyNested.testNested.testFloatArray]).toEqual([ 283 | 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 284 | ]); 285 | ``` 286 | 287 | Allocate and parse a big memory chunk as array of objects: 288 | 289 | ```javascript 290 | const iterations = 5e5; 291 | const binTest3 = new ArrayBuffer(BinaryTest.binarySize * iterations); 292 | const dv3 = new DataView(binTest3); 293 | const bObjList = new Array(iterations); 294 | for (let i = 0; i < iterations; i++) { 295 | bObjList.push(new BinaryTest(dv3, BinaryTest.binarySize * i)); 296 | } 297 | bObjList.forEach((obj, index) => (obj.id = `i${index}`)); 298 | const ids = bObjList.map(({ id }) => id); 299 | ``` 300 | 301 | ## Memory owner 302 | 303 | This library does not aims to own the memory, allowing to use it in different ways. The memory can be allocated from a parallel worker, from the WebAssembly code or from another library or API which can 304 | be consumed using `ArrayBuffer` or `SharedBuffer`. It's recommended to wrap this library with the one managing the memory. 305 | 306 | **Note:** Opting in into managing your own memory (as in C) requires you to understand what you are doing at a low level. Things like dynamic array sizes or text manipulation can be a pain if you don't 307 | understand the basics (not to say about endianness or memory padding). There are several standards and known ways to manage the memory. This library aims to make it much easier to parse it (read and write), 308 | but you'll still need to know how it works. Specifically, this libs does not aims to own the memory pieces: you'll need to create/allocate/move/copy/reallocate/free them around instantiating the JS binary objects. 309 | 310 | ## Use cases 311 | 312 | The environments where direct memory management would be desirable are minimal in JS. Still, there are some edge cases where it could be benefficial or mandatory to do so. 313 | 314 | ### WebAssembly 315 | 316 | WebAssembly allows coding in some low level language (like C, C++ or Rust) and compiling to some binary code which can be executed by a JS interpreter (with WebAssembly API, of course). 317 | 318 | The code compiled into WebAssembly can use dedicated libraries to communicate with the JS code. It allows accessing the DOM (thus, the `window` object), but also sharing pieces of memory 319 | using `WebAssembly.Memory`. Using that, you could write complex but very fast code to do heavy calculations in your compiled code, and trigger some kind of JS re-render using the currently 320 | calculated values at some time or frame-rate. 321 | 322 | ### Disable Garbage Collector (GC) 323 | 324 | As app states is mostly managed by the `ArrayBuffer` (except some JS internal caches), you can minimize GC works, which will run your game (app) much smoothly without unexpected background GC tasks. 325 | 326 | ### Workers API 327 | 328 | Similar to the WebAssembly use case, some one could create a `SharedBuffer` and use it from different Workers, allowing your app to use more than one CPU. For example in a game: you could have 329 | the main worker which updates the `DOM` (or a `canvas` or a OpenGL) using the data from the buffer, while having several workers calculating 3D collisions. 330 | 331 | ### Saving/restoring states 332 | 333 | As all the data is in a single memory piece, you can easily save it to somewhere and load it later to restore the state. This could be benefficial for games, as well as AIs, 3D renderers, scientific 334 | calculations, password crackers, etc. 335 | 336 | ### Accessing binary data files 337 | 338 | Dynamic binary reading, processing and writing (to server or directly to user), like images, audio, video, medical data (DICOM), etc. 339 | 340 | ### Accessing binary APIs 341 | 342 | You could take full advantage of browsers USB and/or Bluetooth APIs, but also you could easily communicate against binary API servers or IoT. Though, as those are usually read-only or 343 | stream based, you would preffer using `DataStreams.js` instead. 344 | 345 | ### Develop backend DB APIs 346 | 347 | Some libraries allows maintaining shared pieces of memory between the backend app and the database. This lib could help developing Node database middlewares. 348 | 349 | ## See also 350 | 351 | There are several JS projects aiming to handle binary data: 352 | 353 | - [buffer-backed-object](https://github.com/GoogleChromeLabs/buffer-backed-object): creates objects that are backed by an ArrayBuffer 354 | - [@bnaya/objectbuffer](https://www.npmjs.com/package/@bnaya/objectbuffer) ([source code](https://github.com/Bnaya/objectbuffer/)): JavaScript Object like api, backed by an arraybuffer 355 | - [DataStream.js](https://github.com/kig/DataStream.js): library for reading data from ArrayBuffers 356 | - [Restructure](https://www.npmjs.com/package/restructure) 357 | - [Restructure (next)](https://www.npmjs.com/package/restructure-next) 358 | - [buffercodec](https://www.npmjs.com/package/buffercodec) 359 | - [Buffer Plus](https://www.npmjs.com/package/buffer-plus) 360 | - [Binary Protocol](https://www.npmjs.com/package/binary-protocol) 361 | - [Binary-parser](https://www.npmjs.com/package/binary-parser) 362 | - [@yotamshacham/schema](https://www.npmjs.com/package/@yotamshacham/schema) 363 | - [Structron](https://www.npmjs.com/package/structron) 364 | - [cppmsg](https://www.npmjs.com/package/cppmsg) 365 | - [bin-protocol](https://www.npmjs.com/package/bin-protocol) 366 | - [byte-data](https://www.npmjs.com/package/byte-data) 367 | - [binobject](https://www.npmjs.com/package/binobject) 368 | - [Binarcular](https://www.npmjs.com/package/binarcular) 369 | - [Uttori Data Tools](https://www.npmjs.com/package/@uttori/data-tools) 370 | - [@avro/types](https://www.npmjs.com/package/@avro/types) 371 | - [Structurae](https://www.npmjs.com/package/structurae) 372 | - [@thi.ng/unionstruct](https://www.npmjs.com/package/@thi.ng/unionstruct) 373 | - [Typed Array Buffer Schema](https://www.npmjs.com/package/@geckos.io/typed-array-buffer-schema) 374 | - [@sighmir/bstruct](https://www.npmjs.com/package/@sighmir/bstruct) 375 | - [binary-parser-encoder](https://www.npmjs.com/package/binary-parser-encoder) 376 | - [binary-encoder](https://www.npmjs.com/package/binary-encoder) 377 | - [c-struct](https://www.npmjs.com/package/c-struct) 378 | - [binary-transfer](https://www.npmjs.com/package/binary-transfer) 379 | - [Superbuffer](https://www.npmjs.com/package/superbuffer) 380 | - [@binary-files/structjs](https://www.npmjs.com/package/@binary-files/structjs) 381 | - [js Binary Schema Parser](https://www.npmjs.com/package/js-binary-schema-parser) 382 | - [jDataView/jBinary](https://github.com/jDataView/jBinary) 383 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Reporting a Vulnerability 4 | 5 | If you find a security bug (in this library or its dependencies), 6 | [open a security advisory](https://github.com/emibcn/binary-object/security/advisories/new). 7 | This ensures the library can be updated before making this public, allowing users to update in that moment. 8 | 9 | The response time may vary depending on availability. If the issue is confirmed: 10 | 11 | - If the vulnerability is confirmed (a user can be negativelly affected): will be solved as soon as possible, 12 | and the advisory and the upgrade will be made public at the same time. 13 | - If the bug exists but no user can be affected, the issue will be made public and added to the normal TODO queue list. 14 | -------------------------------------------------------------------------------- /babelrc.test.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [['@babel/preset-env', { targets: { node: 'current' } }]], 3 | plugins: [ 4 | '@babel/plugin-transform-runtime', 5 | [ 6 | '@babel/plugin-proposal-decorators', 7 | { 8 | legacy: true 9 | } 10 | ], 11 | [ 12 | '@babel/plugin-proposal-class-properties', 13 | { 14 | loose: true 15 | } 16 | ] 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /jsdoc.json: -------------------------------------------------------------------------------- 1 | { 2 | "plugins": ["plugins/markdown", "plugins/summarize"], 3 | "templates": { 4 | "cleverLinks": false, 5 | "monospaceLinks": true 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@3m1/binary-object", 3 | "version": "1.1.7", 4 | "description": "Manage binary data with JavaScript strictly typed Object-oriented programming", 5 | "main": "dist/index.js", 6 | "module": "dist/index.modern.js", 7 | "source": "src/index.js", 8 | "repository": "git://github.com/emibcn/binary-object", 9 | "homepage": "https://github.com/emibcn/binary-object", 10 | "author": "github.com/emibcn", 11 | "sideEffects": false, 12 | "keywords": [ 13 | "ArrayBuffer", 14 | "DataView", 15 | "buffer", 16 | "type", 17 | "object", 18 | "array", 19 | "iterable", 20 | "bytebuffer", 21 | "binary", 22 | "ObjectBuffer", 23 | "BinaryObject" 24 | ], 25 | "engines": { 26 | "node": ">=10" 27 | }, 28 | "bugs": { 29 | "url": "https://github.com/emibcn/binary-object/issues" 30 | }, 31 | "license": "GPL-3.0-or-later", 32 | "private": false, 33 | "scripts": { 34 | "build": "microbundle --compress --format modern,cjs", 35 | "clean": "rm -Rf dist/ coverage/ doc/", 36 | "start": "microbundle watch --no-compress --format modern,cjs", 37 | "prepare": "run-s build", 38 | "test": "run-s test:unit test:build-test # test:lint", 39 | "test:build": "run-s build", 40 | "test:build-test": "run-s test-build", 41 | "test:lint": "eslint .", 42 | "test:unit": "cross-env CI=1 run-s test-coverage", 43 | "test:unit-html": "yarn test:unit --coverageReporters=html", 44 | "test:watch": "run-s test-coverage", 45 | "test-basic": "node $([ -z ${EXPOSE_GC} ] || echo '--expose-gc') node_modules/.bin/jest $([ -z ${CI} ] && echo '--watchAll') --verbose -w1 --color", 46 | "test-src": "yarn test-basic src/index.test.js", 47 | "test-expose": "cross-env EXPOSE_GC=1 yarn test-src", 48 | "test-inspect": "cross-env NODE_OPTIONS='--inspect' yarn test-src", 49 | "test-inspect-expose": "cross-env NODE_OPTIONS='--inspect' EXPOSE_GC=1 yarn test-src", 50 | "test-coverage": "yarn test-src --coverage", 51 | "test-coverage-html": "yarn test-coverage --coverageReporters=html", 52 | "test-build-prepare": "cp src/*.test.* src/TextEncoder-polyfill.js dist/", 53 | "test-dist": "yarn test-basic dist/index.test.js", 54 | "test-build": "run-s build test-build-prepare test-dist clean", 55 | "deploy": "CI=true np --color --preview", 56 | "deploy-force": "CI=true np --color", 57 | "mkdocs": "yarn jsdoc -c jsdoc.json src -d doc" 58 | }, 59 | "jest": { 60 | "transform": { 61 | "^.+\\.(js|jsx|mjs|cjs|ts|tsx)$": [ 62 | "babel-jest", 63 | { 64 | "configFile": "./babelrc.test.js" 65 | } 66 | ] 67 | } 68 | }, 69 | "publishConfig": { 70 | "registry": "https://registry.npmjs.org", 71 | "access": "public" 72 | }, 73 | "devDependencies": { 74 | "@babel/plugin-proposal-decorators": "^7.14.5", 75 | "@babel/plugin-transform-runtime": "^7.14.5", 76 | "babel-jest": "^29.0.3", 77 | "cross-env": "^7.0.3", 78 | "eslint": "^7.23.0", 79 | "eslint-config-prettier": "^10.0.1", 80 | "eslint-config-standard": "^16.0.2", 81 | "eslint-plugin-import": "^2.22.1", 82 | "eslint-plugin-node": "^11.1.0", 83 | "eslint-plugin-prettier": "^5.2.1", 84 | "eslint-plugin-promise": "^5.1.0", 85 | "eslint-plugin-standard": "^5.0.0", 86 | "jest": "^29.0.3", 87 | "jsdoc": "^4.0.0", 88 | "microbundle": "^0.15.0", 89 | "npm-run-all": "^4.1.5", 90 | "prettier": "^3.0.0", 91 | "util": "^0.12.3" 92 | }, 93 | "dependencies": {}, 94 | "files": [ 95 | "dist" 96 | ] 97 | } 98 | -------------------------------------------------------------------------------- /src/Binary.js: -------------------------------------------------------------------------------- 1 | // Not efficient enough... 2 | // import { nonenumerable } from 'core-decorators'; 3 | 4 | import Types from './Types' 5 | 6 | /** Class allowing `@binary` members */ 7 | class Binary { 8 | // TODO: 9 | // - Handle Endianess 10 | // - Handle Clamped 11 | 12 | // Class props 13 | // Slowers down 4x times... 14 | // @nonenumerable 15 | static _size 16 | /** 17 | * Static getter for the class binary size 18 | * @return {number} - The class binary size 19 | */ 20 | static get binarySize () { 21 | return this._size 22 | } 23 | 24 | // @nonenumerable 25 | static _binaryProps 26 | /** 27 | * Static getter for the class binary props 28 | * @return {array} - The list of binary props 29 | */ 30 | static get binaryProps () { 31 | return this._binaryProps 32 | } 33 | 34 | /** 35 | * Fills an array with objects of this class using a unique buffer 36 | * @param {ArrayBuffer/SharedArrayBuffer/DataView} binOrDv - The buffer where the data lives 37 | * @param {number} length - The number of objects to add to the array 38 | * @param {number} initialOffset - Buffer offset before this object data start 39 | * @param {array} list - The array where new objects will be added 40 | * @return {array} - The array {@link list} where the objects have been added 41 | */ 42 | // @nonenumerable 43 | static arrayFactory (binOrDV, length, initialOffset = 0, list = []) { 44 | // Optimize: Generate a single DataView for all elements 45 | const dv = binOrDV instanceof DataView ? binOrDV : new DataView(binOrDV) 46 | 47 | for (let i = 0; i < length; i++) { 48 | list.push(new this(dv, initialOffset + this._size * i)) 49 | } 50 | 51 | return list 52 | } 53 | 54 | // Prototype props 55 | // @nonenumerable 56 | _initialOffset 57 | // @nonenumerable 58 | _bin 59 | // @nonenumerable 60 | __dv 61 | /** 62 | * Getter of the DataView containing this object's data 63 | * @return {DataView} - The DataView 64 | */ 65 | // @nonenumerable 66 | get _dv () { 67 | this.__dv = 68 | this?.__dv ?? 69 | new DataView(this._bin, this._initialOffset, this.constructor._size) 70 | return this.__dv 71 | } 72 | 73 | /** 74 | * Transform this object into a JSON string containing all the binary members 75 | * @return {string} - The JSON string 76 | * @method 77 | */ 78 | // @nonenumerable 79 | toJSON = () => 80 | this.constructor._binaryProps.reduce( 81 | (acc, prop) => ({ 82 | ...acc, 83 | [prop]: this[prop] 84 | }), 85 | {} 86 | ) 87 | 88 | /** 89 | * Save own initial offset at binary data 90 | * @param {ArrayBuffer/SharedArrayBuffer/DataView} binOrDv - The buffer where the data lives 91 | * @param {number} initialOffset - Buffer offset before this object data start 92 | * @param {boolean} isLazy - If true and {@link binOrDv} is not a {DataView}, wait until first acces before Instantiating the __dv 93 | */ 94 | constructor (binOrDV, initialOffset = 0, isLazy = true) { 95 | this._initialOffset = initialOffset 96 | if (binOrDV instanceof DataView) { 97 | this.__dv = binOrDV 98 | } else { 99 | this._bin = binOrDV 100 | if (!isLazy) { 101 | this._dv // Call getter 102 | } 103 | } 104 | } 105 | 106 | /** 107 | * Get a single byte (as unsigned integer) from a position 108 | * @param {number} offset - The position of the byte to get 109 | * @return {number} - The unsigned numerical number at the specified position 110 | * @method 111 | */ 112 | // @nonenumerable 113 | getByteAt = (offset) => 114 | Types.Uint8.get(this._dv, this._initialOffset + offset) 115 | } 116 | 117 | /* 118 | Object.defineProperty(Binary, "_size", { 119 | enumerable: false, 120 | writable: true, 121 | }); 122 | Object.defineProperty(Binary, "binarySize", { 123 | enumerable: false, 124 | get () { return this._size } 125 | }); 126 | 127 | Object.defineProperty(Binary, "_binaryProps", { 128 | enumerable: false, 129 | writable: true, 130 | }); 131 | Object.defineProperty(Binary, "binaryProps", { 132 | enumerable: false, 133 | get () { return this._binaryProps } 134 | }); 135 | */ 136 | 137 | export default Binary 138 | -------------------------------------------------------------------------------- /src/BinaryArray.js: -------------------------------------------------------------------------------- 1 | /** Class for returning array members from {@link Binary} objects */ 2 | class BinaryArrayBase { 3 | // @member 4 | type 5 | // @member 6 | dv 7 | // @member 8 | offset 9 | // @member 10 | length 11 | // @member 12 | bytes 13 | 14 | /** 15 | * Creates a new customized array 16 | * @param {DataView} dv - The DataView handling the buffer where the data lives 17 | * @param {object} type - The type of the array members from {@link Types} 18 | * @param {number} offset - The offset of the first member of the array into the buffer 19 | * @param {number} length - The length of the array 20 | */ 21 | constructor (dv, type, offset, length) { 22 | this.type = type 23 | this.dv = dv 24 | this.offset = offset 25 | this.length = length 26 | this.bytes = length * type.bytes 27 | } 28 | 29 | /** 30 | * Proxy array methods using this iterator 31 | * @param {function} fn - The function to apply on the array elements 32 | * @return {array} - The new generated array (not bound to original values) 33 | * @method 34 | */ 35 | map = (fn) => Array.from(this, fn) 36 | // reduce = (...args) => Array.prototype.reduce.call([...this], ...args); 37 | 38 | /** 39 | * Transform this array into a JSON string 40 | * @return {string} - The JSON string representing this array 41 | * @method 42 | */ 43 | toJSON = () => JSON.parse(JSON.stringify(this.map())); 44 | 45 | /** 46 | * Make a generator iterator 47 | * @method 48 | * @generator 49 | * @function iterator 50 | * @yield {any} - Each of this array elements of type {@link Types} 51 | * @name iterator 52 | */ 53 | * [Symbol.iterator] () { 54 | // Deconstruct to optimize and ease reading 55 | const { 56 | length, 57 | dv, 58 | offset, 59 | type: { get, bytes } 60 | } = this 61 | 62 | // Use a new index for each iterator. This makes multiple 63 | // iterations over the iterable safe for non-trivial cases, 64 | // such as use of break or nested looping over the same iterable. 65 | for (let index = 0; index < length; index++) { 66 | yield get(dv, offset + bytes * index) 67 | } 68 | } 69 | } 70 | 71 | /** 72 | * A Proxy handler for the {@link BinaryArray} class to allow accessing its elements 73 | * @enum 74 | */ 75 | const BinaryArrayHandler = { 76 | /** 77 | * Getter for the elements of the handled {@link BinaryArray} 78 | * @param {BinaryArray} target - The handled {@link BinaryArray} instance 79 | * @param {string} prop - The property to return (only handled when prop is a string representing a number) 80 | * @return {any} - The element at {@link prop} position, or a reflected value from {@link target} 81 | */ 82 | get (target, prop) { 83 | // Very inefficient way 84 | // Need to: 85 | // - Override Array internals, but are private 86 | // - Override `[]` operator, but it's not possible 87 | if (prop === '0' || (typeof prop === 'string' && Number(prop) > 0)) { 88 | // Destructure to optimize 89 | const { 90 | dv, 91 | offset, 92 | type: { get, bytes } 93 | } = target 94 | return get(dv, offset + bytes * Number(prop)) 95 | } 96 | 97 | // Return original value 98 | return Reflect.get(target, prop) 99 | }, 100 | 101 | /** 102 | * Setter for the elements of the handled {@link BinaryArray} 103 | * @param {BinaryArray} target - The handled {@link BinaryArray} instance 104 | * @param {string} prop - The property to set (only handled when prop is a string representing a number) 105 | * @param {any} value - The value to assign to the {@link prop}'th element 106 | * @return {boolean} - If {@link prop} is numericalish, true (as needed for JS setters), else the return value from the {@link target} reflected setter 107 | */ 108 | set (target, prop, value) { 109 | if (prop === '0' || (typeof prop === 'string' && Number(prop) > 0)) { 110 | // Destructure to optimize 111 | const { 112 | dv, 113 | offset, 114 | type: { set, bytes } 115 | } = target 116 | set(dv, offset + bytes * Number(prop), value) 117 | return true 118 | } 119 | return Reflect.set(target, prop, value) 120 | } 121 | } 122 | 123 | // #TODO: BUG: Argument Spread Operator not working 124 | // well when packing with webpack 125 | /** 126 | * Proxy creator for {@link BinaryArrayBase} 127 | * @param {DataView} dv - The DataView handling the buffer where the data lives 128 | * @param {object} type - The type of the array members from {@link Types} 129 | * @param {number} offset - The offset before the first member of the array 130 | * @param {number} length - The length of the array 131 | * @return {Proxy} - The proxy to {@link BinaryArrayBase} with {@link BinaryArrayHandler} as proxy handler 132 | */ 133 | const BinaryArray = (dv, type, offset, length) => { 134 | return new Proxy( 135 | new BinaryArrayBase(dv, type, offset, length), 136 | BinaryArrayHandler 137 | ) 138 | } 139 | 140 | export default BinaryArray 141 | -------------------------------------------------------------------------------- /src/TextEncoder-polyfill.js: -------------------------------------------------------------------------------- 1 | // Mock Node missing TextEncoder and TextDecoder APIs from its `util` lib 2 | if (!('TextEncoder' in global)) { 3 | import('util').then((nodeUtil) => { 4 | global.TextEncoder = nodeUtil.TextEncoder 5 | global.TextDecoder = nodeUtil.TextDecoder 6 | }) 7 | } 8 | -------------------------------------------------------------------------------- /src/Types.js: -------------------------------------------------------------------------------- 1 | import BinaryArray from './BinaryArray' 2 | 3 | /** 4 | * Types used by the {@link binary} decorator 5 | * @enum 6 | */ 7 | const Types = { 8 | Float32: { 9 | extractor: Float32Array, 10 | bytes: 4, 11 | get: (dv, offset) => dv.getFloat32(offset), 12 | set: (dv, offset, value) => dv.setFloat32(offset, value) 13 | }, 14 | Float64: { 15 | extractor: Float64Array, 16 | bytes: 8, 17 | get: (dv, offset) => dv.getFloat64(offset), 18 | set: (dv, offset, value) => dv.setFloat64(offset, value) 19 | }, 20 | Int8: { 21 | extractor: Int8Array, 22 | bytes: 1, 23 | get: (dv, offset) => dv.getInt8(offset), 24 | set: (dv, offset, value) => dv.setInt8(offset, value) 25 | }, 26 | Int16: { 27 | extractor: Int16Array, 28 | bytes: 2, 29 | get: (dv, offset) => dv.getInt16(offset), 30 | set: (dv, offset, value) => dv.setInt16(offset, value) 31 | }, 32 | Int32: { 33 | extractor: Int32Array, 34 | bytes: 4, 35 | get: (dv, offset) => dv.getInt32(offset), 36 | set: (dv, offset, value) => dv.setInt32(offset, value) 37 | }, 38 | BigInt64: { 39 | extractor: BigInt64Array, 40 | bytes: 8, 41 | get: (dv, offset) => dv.getBigInt64(offset), 42 | set: (dv, offset, value) => dv.setBigInt64(offset, value) 43 | }, 44 | Uint8: { 45 | extractor: Uint8Array, 46 | bytes: 1, 47 | get: (dv, offset) => dv.getUint8(offset), 48 | set: (dv, offset, value) => dv.setUint8(offset, value) 49 | }, 50 | /** Not implemented */ 51 | Uint8Clamped: { 52 | extractor: Uint8ClampedArray, 53 | bytes: 1 54 | }, 55 | Uint16: { 56 | extractor: Uint16Array, 57 | bytes: 2, 58 | get: (dv, offset) => dv.getUint16(offset), 59 | set: (dv, offset, value) => dv.setUint16(offset, value) 60 | }, 61 | Uint32: { 62 | extractor: Uint32Array, 63 | bytes: 4, 64 | get: (dv, offset) => dv.getUint32(offset), 65 | set: (dv, offset, value) => dv.setUint32(offset, value) 66 | }, 67 | BigUint64: { 68 | extractor: BigUint64Array, 69 | bytes: 8, 70 | get: (dv, offset) => dv.getBigUint64(offset), 71 | set: (dv, offset, value) => dv.setBigUint64(offset, value) 72 | }, 73 | 74 | /** 75 | * Array type generator `(type, length, padding=false)` 76 | * @function 77 | * @param {@link Types} type - One of Types.* 78 | * @param {number} length - The number of elements of the array 79 | * @param {boolean} padding - If true, adds initial unused bytes so initialOffset is a multiple of the elements size. One byte size {@link Types} are always treated as padded for optimization. 80 | * @return {object} - The generated Types.* compliant 81 | */ 82 | Array: (type, length, padding = false) => { 83 | return { 84 | bytes: length * type.bytes, 85 | padding: padding && type.bytes, 86 | // Change getter/setter depending on padding ensured 87 | // 1-byte sized native types always have padding ensured 88 | ...(padding || ('extractor' in type && type.bytes === 1) 89 | ? { 90 | get (dv, offset) { 91 | return new type.extractor(dv.buffer, offset, length) 92 | }, 93 | set (dv, offset, values) { 94 | const typed = new type.extractor(dv.buffer, offset, length) 95 | typed.set(values) 96 | return true 97 | } 98 | } 99 | : { 100 | get (dv, offset) { 101 | return BinaryArray(dv, type, offset, length) 102 | }, 103 | set (dv, offset, values) { 104 | values.forEach((value, index) => 105 | type.set(dv, offset + type.bytes * index, value) 106 | ) 107 | return true 108 | } 109 | }) 110 | } 111 | }, 112 | 113 | /** 114 | * Nested/composited struct generator `(Class)` which extends {@link Binary} 115 | * @function 116 | * @param {class} Class - The class the wrapped member belongs to 117 | * @return {object} - The generated {@link Types} compliant 118 | */ 119 | Struct: (Class) => { 120 | return { 121 | bytes: Class.binarySize, 122 | get (dv, offset) { 123 | return new Class(dv, offset) 124 | }, 125 | set (dv, offset, values) { 126 | // TODO: Test if values is a Binary Object and we can just copy binary data, or nothing, 127 | // because binary data, class and offset are the same. 128 | const obj = new Class(dv, offset) 129 | for (const prop of Object.keys(values)) { 130 | if (Class.binaryProps.includes(prop)) { 131 | obj[prop] = values[prop] 132 | } 133 | } 134 | return true 135 | } 136 | } 137 | }, 138 | 139 | /** 140 | * Text generator `(length, {encoding='utf8', zeroTerminated=true}={})` 141 | * @function 142 | * @param {number} length - The maximum length of the binary array (not necessarily equal to the string length) 143 | * @param {object} options - The options for the generated text field: 144 | * - @param {text} encoding - The encoding (defaults to utf8) 145 | * - @param {boolean} zeroTerminated - True if using the C zero terminated strings (default) 146 | * @return {object} - The generated Types.* compliant 147 | */ 148 | Text: (length, { encoding = 'utf8', zeroTerminated = true } = {}) => { 149 | const decoder = new TextDecoder(encoding) 150 | const encoder = new TextEncoder() // Only UTF8 available 151 | return { 152 | bytes: length, 153 | get (dv, offset) { 154 | const arr = new Types.Uint8.extractor(dv.buffer, offset, length) 155 | 156 | if (zeroTerminated) { 157 | const firstZero = arr.indexOf(0x00) 158 | if (firstZero === 0) { 159 | return '' 160 | } else if (firstZero > 0) { 161 | const arrSmaller = new Types.Uint8.extractor( 162 | dv.buffer, 163 | offset, 164 | firstZero 165 | ) 166 | return decoder.decode(arrSmaller) 167 | } 168 | } 169 | 170 | return decoder.decode(arr) 171 | }, 172 | set (dv, offset, value) { 173 | const arr = new Types.Uint8.extractor(dv.buffer, offset, length) 174 | const { read, written } = encoder.encodeInto(value, arr) 175 | 176 | if (zeroTerminated && written < arr.length) { 177 | arr[written] = 0 // append null if room 178 | } 179 | 180 | return true 181 | } 182 | } 183 | } 184 | } 185 | 186 | export default Types 187 | -------------------------------------------------------------------------------- /src/decorators.js: -------------------------------------------------------------------------------- 1 | import Types from './Types' 2 | 3 | /** 4 | * Class member decorator generator for Binary class property 5 | * @param {object} type - Any element from the {@link Types} 6 | * @return {function} - The {@link decorator} which generates the {@link propertyDescriptor} to be used to transform a class member into binary backed member 7 | * @decorator 8 | * @method 9 | */ 10 | const binary = ({ bytes, padding = false, get, set }) => { 11 | /** 12 | * The class member generated decorator 13 | * @param {object} target - object which will be `assign`ed to the Class.prototype (extending {@link Binary} or decorated with {@link withBinary}) 14 | * @param {string} name - property name 15 | * @param {object} descriptor - as in `Object.defineProperty(target, name, descriptor)`, like {@link propertyDescriptor} 16 | * @return {object} - The new or modified {@link propertyDescriptor} for this class member 17 | * @method 18 | * @name decorator 19 | */ 20 | return function decorator (target, name, descriptor) { 21 | // const deleted = (() => { 22 | // const {value, initializer, writable} = descriptor; 23 | // return {value, initializer, writable}; 24 | // })(); 25 | 26 | // Add size as static property to Class 27 | target.constructor._size = target.constructor._size ?? 0 28 | target.constructor._binaryProps = target.constructor._binaryProps ?? [] 29 | 30 | // Create an initial padding offset if needed 31 | const size = target.constructor._size 32 | const paddingOffset = padding ? padding - (size % padding) : 0 33 | 34 | // Get this property offset 35 | const offset = target.constructor._size + paddingOffset 36 | 37 | // Add property size to Class size (at static Class property) 38 | target.constructor._size += bytes + paddingOffset 39 | target.constructor._binaryProps.push(name) 40 | 41 | /** 42 | * Property definition returned from {@link binary}'s returned {@link decorator} 43 | * @name propertyDescriptor 44 | */ 45 | return { 46 | // TODO: Do something with initializer as default value 47 | configurable: false, 48 | enumerable: true, 49 | 50 | /** 51 | * Returns the value handled by this class member, defined at its {@link Types} 52 | * @return {any} - The value in memory, translated by the {@link Types} getter 53 | * @this Binary instance 54 | * @name propertyDescriptorGetter 55 | */ 56 | get () { 57 | return get(this._dv, this._initialOffset + offset) 58 | }, 59 | 60 | /** 61 | * Modifies the value handled by this class member, defined at its {@link Types} 62 | * @param {any} value - The new value to be assigned, which will be translated by the {@link Types} setter 63 | * @return {boolean} - Always true, as needed by JS setters 64 | * @this Binary instance 65 | * @name propertyDescriptorSetter 66 | */ 67 | set (value) { 68 | set(this._dv, this._initialOffset + offset, value) 69 | return true 70 | } 71 | } 72 | 73 | return descriptor 74 | } 75 | } 76 | 77 | // Using `withBinary` as class decorator is 4x times faster in 78 | // instantiation (if using @nonenumerable), at the cost of losing some 79 | // JS class syntax benefits. 80 | // If using withBinary, don't use `extend Binary` and don't use `new` either. 81 | /** 82 | * Decorator to add Binary behavior to a class containing `@binary` members, but 83 | * without extending Binary class 84 | * @param {class} Class - A class not extending Binary containing `@binary` members 85 | * @return {@link wrapper} A {@link Class} instantiator 86 | * */ 87 | const withBinary = (Class) => { 88 | /** 89 | * Class wrapper (object constructor) 90 | * @param {ArrayBuffer/SharedArrayBuffer/DataView} binOrDV - The buffer where the data lives 91 | * @param {number} initialOffset - Buffer offset before this object data start 92 | * @param {array} args - Any arguments passed to the class constructor 93 | * @return {@link Class} instance 94 | * @callback wrapper 95 | * */ 96 | const wrapper = (binOrDV, initialOffset = 0, ...args) => { 97 | const target = new Class(...args) 98 | target._dv = binOrDV instanceof DataView ? binOrDV : new DataView(binOrDV) 99 | target._initialOffset = initialOffset 100 | 101 | /** 102 | * Get a single byte (as unsigned integer) from a position 103 | * @param {number} offset - The position of the byte to get 104 | * @return {number} The unsigned numeric value at this byte 105 | * @this {@link Class} instance 106 | */ 107 | target.getByteAt = (offset) => 108 | Types.Uint8.get(this._dv, this._initialOffset + offset) 109 | 110 | // This is desirable, but slowers down instantiation time by 4x times 111 | // Note: `defineProperties` is +0,25 slower 112 | /* 113 | Object.defineProperty(target, 114 | '_dv', { 115 | enumerable: false, 116 | configurable: false, 117 | writable: false, 118 | value: new DataView(bin, initialOffset, Class._size), 119 | }); 120 | Object.defineProperty(target, 121 | '_initialOffset', { 122 | enumerable: false, 123 | configurable: false, 124 | writable: false, 125 | value: initialOffset, 126 | }); 127 | */ 128 | return target 129 | } 130 | 131 | /** 132 | * Allow getting the class size from outside 133 | * @this wrapper 134 | * @static 135 | * @method 136 | * @name binarySize 137 | */ 138 | Object.defineProperty(wrapper, 'binarySize', { 139 | get () { 140 | return Class._size 141 | }, 142 | configurable: false, 143 | enumerable: false 144 | }) 145 | 146 | /** 147 | * Allow getting the class binary props from outside 148 | * @this wrapper 149 | * @static 150 | * @method 151 | * @name binarySize 152 | */ 153 | Object.defineProperty(wrapper, 'binaryProps', { 154 | get () { 155 | return Class._binaryProps 156 | }, 157 | configurable: false, 158 | enumerable: false 159 | }) 160 | 161 | /** 162 | * Array creator helper 163 | * @param {ArrayBuffer/SharedArrayBuffer/DataView} binOrDv - The buffer where the data lives 164 | * @param {number} length - The length of elements to create 165 | * @param {number} initialOffset - The initial offset in the buffer before the first element of the array 166 | * @param {array} list - The array where new objects will be added 167 | * @return {array} - The array {@link list} where the objects have been added 168 | * @this wrapper 169 | * @static 170 | * @method 171 | */ 172 | wrapper.arrayFactory = function ( 173 | binOrDV, 174 | length, 175 | initialOffset = 0, 176 | list = [] 177 | ) { 178 | // Optimize: Generate a single DataView for all elements 179 | const dv = 180 | binOrDV instanceof DataView 181 | ? binOrDV 182 | : new DataView(binOrDV, initialOffset, length * Class._size) 183 | 184 | for (let i = 0; i < length; i++) { 185 | list.push(wrapper(dv, initialOffset + Class._size * i)) 186 | } 187 | 188 | return list 189 | } 190 | 191 | return wrapper 192 | } 193 | 194 | export { withBinary, binary } 195 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | import Types from './Types' 4 | import Binary from './Binary' 5 | import { binary, withBinary } from './decorators' 6 | 7 | export { Types, Binary, binary, withBinary } 8 | -------------------------------------------------------------------------------- /src/index.test.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | import "./TextEncoder-polyfill"; 4 | import { Binary, binary, withBinary, Types } from "./index.js"; 5 | 6 | class BinaryTest extends Binary { 7 | @binary(Types.Uint32) 8 | id = 0; 9 | @binary(Types.Float64) 10 | testFloat = 0; 11 | @binary(Types.Array(Types.Float32, 10)) 12 | testFloatArray; 13 | 14 | showId = () => console.log(`My id is ${this.id}`); 15 | } 16 | 17 | const binTest = new ArrayBuffer(BinaryTest.binarySize); 18 | const proxyObject = new BinaryTest(binTest); 19 | 20 | test("Change property nature (re-define prototype properties) throws error", () => { 21 | expect(() => { 22 | Object.defineProperty(BinaryTest.prototype, "id", { 23 | get: () => 42, 24 | }); 25 | }).toThrow(TypeError); 26 | }); 27 | 28 | test("Binary size is exact (no padding)", () => { 29 | // No padding done (nor needed...) 30 | const expectedSize = 31 | Types.Uint32.bytes + Types.Float64.bytes + Types.Float32.bytes * 10; 32 | expect(BinaryTest.binarySize).toBe(expectedSize); 33 | }); 34 | 35 | test("Get and set properties", () => { 36 | // Initially set to 0 37 | expect(proxyObject.id).toBe(0); 38 | expect(proxyObject.testFloat).toBe(0); 39 | 40 | // Set a value to each member 41 | proxyObject.id = 12345; 42 | proxyObject.testFloat = 7.8; 43 | 44 | expect(proxyObject.id).toBe(12345); 45 | expect(proxyObject.testFloat).toBe(7.8); 46 | }); 47 | 48 | test("Get and set text properties", () => { 49 | class BinaryTextTest extends Binary { 50 | @binary(Types.Uint8) 51 | byte1; 52 | @binary(Types.Text(22)) 53 | name; 54 | @binary(Types.Uint8) 55 | byte2; 56 | } 57 | 58 | const binTest2 = new ArrayBuffer(BinaryTextTest.binarySize); 59 | const testText = new BinaryTextTest(binTest2); 60 | 61 | expect(testText.byte1).toBe(0); 62 | expect(testText.byte2).toBe(0); 63 | expect(testText.name).toBe(""); 64 | testText.name = "H"; 65 | expect(testText.name).toBe("H"); // length: 1 66 | testText.name = "Hi!"; 67 | expect(testText.name).toBe("Hi!"); // length: 3 68 | testText.name = "¡Hôlà Mündó! 😜"; 69 | expect(testText.name).toBe("¡Hôlà Mündó! 😜"); // length: 22 (max) 70 | 71 | // Array overflow 72 | testText.name = "¡Hôlà Mündó! 😜"; 73 | expect(testText.name).not.toBe("¡Hôlà Mündó! 😜"); // length: 23 74 | 75 | // Field boundaries have been respected 76 | expect(testText.byte1).toBe(0); 77 | expect(testText.byte2).toBe(0); 78 | }); 79 | 80 | test("Get and set properties in arrays", () => { 81 | const testArray = proxyObject.testFloatArray; 82 | 83 | // Iteratibility 84 | expect([...testArray]).toEqual(new Array(10).fill(0)); 85 | 86 | // Elements access and modification 87 | expect(testArray[0]).toBe(0); 88 | testArray[0] = 1; 89 | expect(testArray[0]).toBe(1); 90 | expect(testArray[1]).toBe(0); 91 | testArray[1] = 2; 92 | expect(testArray[0]).toBe(1); 93 | expect(testArray[1]).toBe(2); 94 | expect(testArray[2]).toBe(0); 95 | 96 | // Test adding custom prop to array object 97 | testArray.someThing = "something else"; 98 | expect(testArray.someThing).toBe("something else"); 99 | 100 | // Map methods 101 | const mapped = testArray.map((v, i) => [v, i]); 102 | expect(mapped).toEqual([ 103 | [1, 0], 104 | [2, 1], 105 | [0, 2], 106 | [0, 3], 107 | [0, 4], 108 | [0, 5], 109 | [0, 6], 110 | [0, 7], 111 | [0, 8], 112 | [0, 9], 113 | ]); 114 | const reduced = testArray 115 | .map() 116 | .reduce((acc, v, i) => ({ ...acc, [`i${i}`]: v }), {}); 117 | expect(reduced).toEqual({ 118 | i0: 1, 119 | i1: 2, 120 | i2: 0, 121 | i3: 0, 122 | i4: 0, 123 | i5: 0, 124 | i6: 0, 125 | i7: 0, 126 | i8: 0, 127 | i9: 0, 128 | }); 129 | 130 | // Modify full array 131 | const newArr = [1, 0, 0, 0, 0, 0, 0, 0, 0, 1]; 132 | proxyObject.testFloatArray = newArr; 133 | expect([...testArray]).toEqual(newArr); 134 | }); 135 | 136 | test("Test non padded array", () => { 137 | const type = Types.Uint32; 138 | const length = 5; 139 | class BinaryNoPadTest extends Binary { 140 | @binary(Types.Uint8) 141 | someMemberAtTheBegining; 142 | 143 | // Not padded (smaller, slower) 144 | @binary(Types.Array(type, length)) 145 | testArray; 146 | 147 | @binary(Types.Uint8) 148 | someMemberAtTheEnd; 149 | } 150 | 151 | const expectedSize = 152 | 1 + // First byte 153 | length * type.bytes + // Not padded array 154 | 1; // Last byte 155 | expect(BinaryNoPadTest.binarySize).toBe(expectedSize); 156 | }); 157 | 158 | test("Test padded array", () => { 159 | const type = Types.Uint32; 160 | const type1Byte = Types.Int8; 161 | const length = 5; 162 | class BinaryPadTest extends Binary { 163 | @binary(Types.Uint8) 164 | someMemberAtTheBegining; 165 | 166 | // `true` forces array padding 167 | @binary(Types.Array(type, length, true)) 168 | testArray; 169 | 170 | // 1 byte arrays are optimized, even when no `true` is given 171 | @binary(Types.Array(type1Byte, length)) 172 | testArray1Byte; 173 | 174 | @binary(Types.Uint8) 175 | someMemberAtTheEnd; 176 | } 177 | 178 | const binTest2 = new ArrayBuffer(BinaryPadTest.binarySize); 179 | const testObj = new BinaryPadTest(binTest2); 180 | 181 | // The first byte of someMemberAtTheBegining forces to consume 182 | // a full testArray element before it (for padding) 183 | const expectedSize = 184 | (length + 1) * type.bytes + // First byte + First padded array 185 | length * type1Byte.bytes + // Second array 186 | 1; // Last byte 187 | expect(BinaryPadTest.binarySize).toBe(expectedSize); 188 | 189 | // 1 byte array is automatically optimized (without `padding=true`) 190 | expect(testObj.testArray1Byte).toBeInstanceOf(type1Byte.extractor); 191 | 192 | // Test bound TypedArray values 193 | const expectedArr = new Array(length).fill(0); 194 | const arr = testObj.testArray; 195 | expect(arr).toBeInstanceOf(type.extractor); 196 | expect([...arr]).toEqual(expectedArr); 197 | 198 | // Fill first value with binary 1's 199 | const max = eval("0x" + "ff".repeat(type.bytes)); 200 | arr[0] = max; 201 | expectedArr[0] = max; 202 | expect([...arr]).toEqual(expectedArr); 203 | 204 | // Original data has also been modified 205 | expect([...testObj.testArray]).toEqual(expectedArr); 206 | 207 | // Check that the bytes on the buffer have been filled 208 | for (let i = 0; i < type.bytes; i++) { 209 | expect(testObj.getByteAt(i + type.bytes)).toBe(255); 210 | } 211 | 212 | // Test typecasting 213 | arr[0] = 1; 214 | expectedArr[0] = 1; 215 | expect([...arr]).toEqual(expectedArr); 216 | 217 | // Test full array assignment 218 | testObj.testArray = [1, 1, 1]; 219 | expect([...arr]).toEqual([1, 1, 1, 0, 0]); 220 | 221 | // Test array overflow on full assignment throws RangeError 222 | expect(() => { 223 | testObj.testArray = new Array(length + 1).fill(0); 224 | }).toThrow(RangeError); 225 | 226 | // Test array overflow by index does nothing 227 | expect(testObj.testArray[length]).toBe(undefined); 228 | testObj.testArray[length] = 1; 229 | expect(testObj.testArray[length]).toBe(undefined); 230 | }); 231 | 232 | test("Class inheritance works", () => { 233 | class BinaryChildTest extends BinaryTest { 234 | @binary(Types.Uint8) 235 | someMemberAtTheEnd; 236 | } 237 | 238 | const binTest2 = new ArrayBuffer(BinaryChildTest.binarySize); 239 | const testChild = new BinaryChildTest(binTest2); 240 | 241 | // Test inherited member 242 | expect(testChild.id).toBe(0); 243 | testChild.id = 12345; 244 | expect(testChild.id).toBe(12345); 245 | 246 | // Test changing last inherited member does not overflows 247 | const initialArr = new Array(10).fill(0); 248 | expect([...testChild.testFloatArray]).toEqual(initialArr); 249 | const newArr = new Array(10).fill(255); 250 | testChild.testFloatArray = newArr; 251 | expect([...testChild.testFloatArray]).toEqual(newArr); 252 | 253 | // Child members are at the end: test last byte change 254 | expect(testChild.getByteAt(BinaryChildTest.binarySize - 1)).toBe(0); 255 | testChild.someMemberAtTheEnd = 255; 256 | expect(testChild.getByteAt(BinaryChildTest.binarySize - 1)).toBe(255); 257 | }); 258 | 259 | test("Get and set properties in nested structs", () => { 260 | class BinaryNestedTest extends Binary { 261 | @binary(Types.Struct(BinaryTest)) 262 | testNested; 263 | 264 | get id() { 265 | return this.testNested.id; 266 | } 267 | set id(value) { 268 | this.testNested.id = value; 269 | return true; 270 | } 271 | 272 | @binary(Types.Uint32) 273 | someNumber = 0; 274 | 275 | showId = this.testNested.showId; 276 | } 277 | 278 | const binTest2 = new ArrayBuffer(BinaryNestedTest.binarySize); 279 | const proxyNested = new BinaryNestedTest(binTest2); 280 | 281 | // Modify nested prop using a setter 282 | proxyNested.id = 12345; 283 | expect(proxyNested.id).toBe(12345); 284 | expect(proxyNested.testNested.id).toBe(12345); 285 | 286 | // Modify nested last array element 287 | const length = proxyNested.testNested.testFloatArray.length; 288 | proxyNested.testNested.testFloatArray[length - 1] = 5; 289 | proxyNested.someNumber = 1; 290 | expect(proxyNested.someNumber).toBe(1); 291 | expect([...proxyNested.testNested.testFloatArray]).toEqual([ 292 | 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 293 | ]); 294 | 295 | // Modify full nested' array 296 | proxyNested.testNested = { testFloatArray: [0, 0, 0, 0, 0, 0, 0, 0, 0, 1] }; 297 | expect([...proxyNested.testNested.testFloatArray]).toEqual([ 298 | 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 299 | ]); 300 | }); 301 | 302 | test("Get and set properties in nested array of structs and nested JSON fully works", () => { 303 | class BinaryArrayOfNestedTest extends Binary { 304 | @binary(Types.Array(Types.Struct(BinaryTest), 3)) 305 | testNested; 306 | 307 | get id() { 308 | return this.testNested[0].id; 309 | } 310 | set id(value) { 311 | this.testNested[0].id = value; 312 | return true; 313 | } 314 | 315 | @binary(Types.Uint32) 316 | someNumber = 0; 317 | 318 | showId = this.testNested[0].showId; 319 | } 320 | 321 | const binTest2 = new ArrayBuffer(BinaryArrayOfNestedTest.binarySize); 322 | const proxyNested = new BinaryArrayOfNestedTest(binTest2); 323 | 324 | proxyNested.id = 12345; 325 | expect(proxyNested.id).toBe(12345); 326 | expect(proxyNested.testNested[0].id).toBe(12345); 327 | 328 | const offset = BinaryTest.binarySize - 1 + 4; 329 | const notModifiedByte = proxyNested.getByteAt(offset); 330 | expect(notModifiedByte).toBe(0); 331 | proxyNested.testNested[1].id = 255; 332 | const modifiedByte = proxyNested.getByteAt(offset); 333 | expect(modifiedByte).toBe(255); 334 | 335 | const savedJSON = 336 | '{"testNested":[{"id":12345,"testFloat":0,"testFloatArray":[0,0,0,0,0,0,0,0,0,0]},{"id":255,"testFloat":0,"testFloatArray":[0,0,0,0,0,0,0,0,0,0]},{"id":0,"testFloat":0,"testFloatArray":[0,0,0,0,0,0,0,0,0,0]}],"someNumber":0}'; 337 | expect(JSON.stringify(proxyNested)).toBe(savedJSON); 338 | }); 339 | 340 | test("Get and set properties on object with independent binary data", () => { 341 | // Create a new object bound to the same array buffer 342 | const binTest2 = new ArrayBuffer(BinaryTest.binarySize); 343 | const proxyObject2 = new BinaryTest(binTest2); 344 | 345 | // Initially set to 0 346 | expect(proxyObject2.id).toBe(0); 347 | expect(proxyObject2.testFloat).toBe(0); 348 | 349 | // Set values in new object 350 | proxyObject2.id = 54321; 351 | proxyObject2.testFloat = 0.3; 352 | 353 | // Only new object must have changed 354 | expect(proxyObject2.id).toBe(54321); 355 | expect(proxyObject2.testFloat).toBe(0.3); 356 | 357 | expect(proxyObject.id).toBe(12345); 358 | expect(proxyObject.testFloat).toBe(7.8); 359 | }); 360 | 361 | test("Get and set properties on object with shared binary data", () => { 362 | // Create a new object bound to the same array buffer 363 | const proxyObject2 = new BinaryTest(binTest); 364 | 365 | // Set values in new object 366 | proxyObject2.id = 54321; 367 | proxyObject2.testFloat = 0.3; 368 | 369 | // Both object must have changed their member values 370 | expect(proxyObject2.id).toBe(54321); 371 | expect(proxyObject2.testFloat).toBe(0.3); 372 | 373 | expect(proxyObject.id).toBe(54321); 374 | expect(proxyObject.testFloat).toBe(0.3); 375 | }); 376 | 377 | test("Instantiate an object with a binary data using an initial offset > 0", () => { 378 | // Create a new object bound to the same array buffer 379 | const initialSize = 12; // 3 * Int32 380 | const binTest2 = new ArrayBuffer(BinaryTest.binarySize + initialSize); 381 | const proxyObject2 = new BinaryTest(binTest2, initialSize); 382 | 383 | // Create a DV to manage the initial 12 bytes with 3 Int32 values 384 | const initialsDV = new DataView(binTest2, 0, initialSize); 385 | initialsDV.setInt32(0, 1); 386 | initialsDV.setInt32(4, 2); 387 | initialsDV.setInt32(8, 3); 388 | 389 | // Initially set to 0 390 | expect(proxyObject2.id).toBe(0); 391 | expect(proxyObject2.testFloat).toBe(0); 392 | 393 | // Set values in new object 394 | proxyObject2.id = 54321; 395 | proxyObject2.testFloat = 0.3; 396 | 397 | // Only new object must have changed 398 | expect(proxyObject2.id).toBe(54321); 399 | expect(proxyObject2.testFloat).toBe(0.3); 400 | 401 | const expectedValues = [1, 2, 3]; 402 | const values = expectedValues.map((_, index) => 403 | initialsDV.getInt32(index * 4), 404 | ); 405 | expect(values).toEqual(expectedValues); 406 | }); 407 | 408 | test("Profile a natural object against a binary object", async () => { 409 | const sleep = (millis) => 410 | new Promise((resolve) => setTimeout(resolve, millis)); 411 | 412 | let gc = () => { 413 | global.gc(); 414 | global.gc(); 415 | global.gc(); 416 | global.gc(); 417 | global.gc(); 418 | global.gc(); 419 | }; 420 | 421 | // Use Node Garbage Collector to profile memory usage more precisely 422 | try { 423 | gc(); 424 | } catch (e) { 425 | console.error("`node --expose-gc index.js`"); 426 | //process.exit(1); 427 | gc = () => {}; 428 | } 429 | 430 | // Natural object to test against 431 | class NaturalObject { 432 | id = 0; 433 | testFloat = 0.0; 434 | testFloatArray = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]; 435 | } 436 | 437 | // Lots of iterations to get relevant time lapses 438 | const iterations = 3e5; 439 | 440 | // Save memory and time profiling info 441 | const memory = []; 442 | 443 | // Get initial usage before starting the profile 444 | memory.push({ 445 | usage: process.memoryUsage(), 446 | name: "Start", 447 | }); 448 | 449 | // Helper to launch each profile test 450 | const testProfile = async (name, fn) => { 451 | const dateStart = new Date(); 452 | const ret = await fn(); 453 | const dateEnd = new Date(); 454 | const time = dateEnd - dateStart; 455 | memory.push({ 456 | usage: process.memoryUsage(), 457 | name, 458 | time, 459 | }); 460 | return ret; 461 | }; 462 | 463 | const testObjList = async (name, objList) => { 464 | await testProfile(`${name} modification`, () => { 465 | objList.forEach((obj, id) => { 466 | obj.id = id; 467 | }); 468 | }); 469 | 470 | const matched = await testProfile(`${name} access`, () => { 471 | return objList.every((obj, id) => id === obj.id); 472 | }); 473 | expect(matched).toBe(true); 474 | 475 | await testProfile(`${name} access 2nd phase`, () => { 476 | objList.every((obj, id) => id === obj.id); 477 | }); 478 | 479 | await testProfile(`${name} modification 2nd phase`, () => { 480 | objList.forEach((obj, id) => { 481 | obj.id = id; 482 | }); 483 | }); 484 | 485 | if ("testFloatArray" in objList[0]) { 486 | await testProfile(`${name} access array element`, () => { 487 | objList.every(({ testFloatArray }) => testFloatArray[0] === 0); 488 | }); 489 | 490 | await testProfile(`${name} modification array element`, () => { 491 | objList.forEach(({ testFloatArray }, id) => (testFloatArray[0] = id)); 492 | }); 493 | 494 | await testProfile(`${name} access array element 2nd phase`, () => { 495 | objList.every(({ testFloatArray }, id) => testFloatArray[0] === id); 496 | }); 497 | 498 | await testProfile(`${name} modification array element 2nd phase`, () => { 499 | objList.forEach( 500 | ({ testFloatArray }, id) => (testFloatArray[0] = id * 2), 501 | ); 502 | }); 503 | } 504 | 505 | await testProfile(`${name} garbage collected`, async () => { 506 | gc(); 507 | await sleep(1000); 508 | gc(); 509 | }); 510 | }; 511 | 512 | gc(); 513 | 514 | // 515 | // Natural Object 516 | // 517 | const nObjList = []; // new Array(iterations) is much slower 518 | await testProfile("Natural Object instantation", () => { 519 | for (let i = 0; i < iterations; i++) { 520 | nObjList.push(new NaturalObject()); 521 | } 522 | }); 523 | 524 | await testObjList("Natural Object", nObjList); 525 | 526 | // 527 | // Binary Object 528 | // 529 | let bObjList; 530 | await testProfile("Binary Object instantation", () => { 531 | const binTest2 = new ArrayBuffer(BinaryTest.binarySize * iterations); 532 | bObjList = BinaryTest.arrayFactory(binTest2, iterations); 533 | }); 534 | 535 | await testObjList("Binary Object", bObjList); 536 | 537 | // 538 | // Binary Object with pre-created DataView 539 | // 540 | let binTest3, dv3, bDvObjList; 541 | await testProfile( 542 | "Binary Object with pre-created DataView alloc memory", 543 | () => { 544 | binTest3 = new ArrayBuffer(BinaryTest.binarySize * iterations); 545 | dv3 = new DataView(binTest3); 546 | }, 547 | ); 548 | await testProfile( 549 | "Binary Object with pre-created DataView instantation", 550 | () => { 551 | bDvObjList = BinaryTest.arrayFactory(dv3, iterations); 552 | }, 553 | ); 554 | 555 | await testObjList("Binary Object with pre-created DataView", bDvObjList); 556 | 557 | // 558 | // Binary Object with padded array 559 | // 560 | let bwpaObjList; 561 | await testProfile("Binary Object with padded array instantiation", () => { 562 | class BinaryTestPadded extends Binary { 563 | @binary(Types.Uint32) 564 | id = 0; 565 | @binary(Types.Float64) 566 | testFloat = 0; 567 | @binary(Types.Array(Types.Float32, 10, true)) 568 | testFloatArray; 569 | 570 | showId = () => console.log(`My id is ${this.id}`); 571 | } 572 | 573 | const binTest2 = new ArrayBuffer(BinaryTestPadded.binarySize * iterations); 574 | bwpaObjList = BinaryTestPadded.arrayFactory(binTest2, iterations); 575 | }); 576 | 577 | await testObjList("Binary Object with padded array", bwpaObjList); 578 | 579 | // 580 | // Binary Object without array 581 | // 582 | let bwoaObjList; 583 | await testProfile("Binary Object without array instantation", () => { 584 | class BinaryWithoutArrayTest extends Binary { 585 | @binary(Types.Uint32) 586 | id = 0; 587 | @binary(Types.Float64) 588 | testFloat = 0; 589 | 590 | showId = () => console.log(`My id is ${this.id}`); 591 | } 592 | 593 | const binTest2 = new ArrayBuffer( 594 | BinaryWithoutArrayTest.binarySize * iterations, 595 | ); 596 | bwoaObjList = BinaryWithoutArrayTest.arrayFactory(binTest2, iterations); 597 | }); 598 | 599 | await testObjList("Binary Object without array", bwoaObjList); 600 | 601 | // 602 | // Binary Object with class decorator 603 | // 604 | let bdObjList; 605 | await testProfile("Binary Object with class decorator instantation", () => { 606 | @withBinary 607 | class BinaryObjectWithDecorator { 608 | @binary(Types.Uint32) 609 | id = 0; 610 | @binary(Types.Float64) 611 | testFloat = 0; 612 | @binary(Types.Array(Types.Float32, 10)) 613 | testFloatArray; 614 | 615 | showId = () => console.log(`My id is ${this.id}`); 616 | } 617 | 618 | const binTest2 = new ArrayBuffer( 619 | BinaryObjectWithDecorator.binarySize * iterations, 620 | ); 621 | bdObjList = BinaryObjectWithDecorator.arrayFactory(binTest2, iterations); 622 | }); 623 | 624 | await testObjList("Binary Object with class decorator", bdObjList); 625 | 626 | // 627 | // Binary Object with class decorator and padded array 628 | // 629 | let bdpObjList; 630 | await testProfile( 631 | "Binary Object with class decorator instantation and padded array", 632 | () => { 633 | @withBinary 634 | class BinaryObjectWithDecorator { 635 | @binary(Types.Uint32) 636 | id = 0; 637 | @binary(Types.Float64) 638 | testFloat = 0; 639 | @binary(Types.Array(Types.Float32, 10, true)) 640 | testFloatArray; 641 | 642 | showId = () => console.log(`My id is ${this.id}`); 643 | } 644 | 645 | const binTest2 = new ArrayBuffer( 646 | BinaryObjectWithDecorator.binarySize * iterations, 647 | ); 648 | bdpObjList = BinaryObjectWithDecorator.arrayFactory(binTest2, iterations); 649 | }, 650 | ); 651 | 652 | await testObjList( 653 | "Binary Object with class decorator and padded array", 654 | bdpObjList, 655 | ); 656 | 657 | // Show collected metrics in a table 658 | const numberWithCommas = (x) => 659 | x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ","); 660 | const memoryDiffTable = memory 661 | .map(({ usage, ...rest }, indexMemory) => ({ 662 | ...rest, 663 | ...Object.entries(usage) 664 | .map(([key, value]) => ({ 665 | key, 666 | originalValue: value, 667 | value: 668 | indexMemory === 0 ? 0 : value - memory[indexMemory - 1].usage[key], 669 | })) 670 | .reduce( 671 | (acc, { key, value }) => ({ 672 | ...acc, 673 | [key]: numberWithCommas(value), 674 | }), 675 | {}, 676 | ), 677 | })) 678 | .reduce( 679 | (acc, { name, ...rest }) => ({ 680 | ...acc, 681 | [name]: rest, 682 | }), 683 | {}, 684 | ); 685 | console.table(memoryDiffTable); 686 | }, 6e4); 687 | --------------------------------------------------------------------------------