├── .editorconfig
├── .env.example
├── .github
└── workflows
│ ├── feature.yml
│ ├── staging.yml
│ └── tag.yml
├── .gitignore
├── .npmignore
├── LICENSE
├── README.md
├── docs
├── .nojekyll
├── assets
│ ├── highlight.css
│ ├── main.js
│ ├── search.js
│ └── style.css
├── classes
│ ├── IdDeterministic.html
│ ├── IdInternal.html
│ ├── IdRandom.html
│ └── IdSortable-1.html
├── functions
│ ├── idSortable.extractRand.html
│ ├── idSortable.extractSeq.html
│ ├── idSortable.extractTs.html
│ ├── utils.bits2bytes.html
│ ├── utils.bytes2bits.html
│ ├── utils.bytes2hex.html
│ ├── utils.dec2bits.html
│ ├── utils.dec2hex.html
│ ├── utils.equals.html
│ ├── utils.fromBuffer.html
│ ├── utils.fromFixedPoint.html
│ ├── utils.fromJSON.html
│ ├── utils.fromMultibase.html
│ ├── utils.fromString.html
│ ├── utils.fromUUID.html
│ ├── utils.hex2bytes.html
│ ├── utils.nodeBits.html
│ ├── utils.randomBits.html
│ ├── utils.randomBytes.html
│ ├── utils.roundPrecise.html
│ ├── utils.strChunks.html
│ ├── utils.take.html
│ ├── utils.timeSource.html
│ ├── utils.toBuffer.html
│ ├── utils.toFixedPoint.html
│ ├── utils.toJSON.html
│ ├── utils.toMultibase.html
│ ├── utils.toString.html
│ └── utils.toUUID.html
├── index.html
├── modules.html
├── modules
│ ├── idSortable.html
│ └── utils.html
└── types
│ ├── Id.html
│ └── utils.MultibaseFormats.html
├── flake.lock
├── flake.nix
├── jest.config.mjs
├── package-lock.json
├── package.json
├── scripts
├── brew-install.sh
├── choco-install.ps1
└── test.mjs
├── src
├── Id.ts
├── IdDeterministic.ts
├── IdRandom.ts
├── IdSortable.ts
├── index.ts
└── utils.ts
├── tests
├── Id.test.ts
├── IdDeterministic.test.ts
├── IdRandom.test.ts
├── IdSortable.test.ts
├── global.d.ts
├── globalSetup.ts
├── globalTeardown.ts
├── setup.ts
├── setupAfterEnv.ts
├── utils.test.ts
└── utils.ts
├── tsconfig.build.json
└── tsconfig.json
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | end_of_line = lf
5 | indent_style = space
6 | indent_size = 2
7 | insert_final_newline = true
8 | trim_trailing_whitespace = true
--------------------------------------------------------------------------------
/.env.example:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/MatrixAI/js-id/9654b7fd0c75e31f357af6cbb7a8af849974503f/.env.example
--------------------------------------------------------------------------------
/.github/workflows/feature.yml:
--------------------------------------------------------------------------------
1 | name: "CI / Feature"
2 |
3 | on:
4 | push:
5 | branches:
6 | - feature*
7 | workflow_dispatch:
8 |
9 | concurrency:
10 | group: ${{ github.workflow }}-${{ github.ref }}
11 | cancel-in-progress: true
12 |
13 | jobs:
14 | use-library-js-feature:
15 | permissions:
16 | contents: read
17 | actions: write
18 | checks: write
19 | uses: MatrixAI/.github/.github/workflows/library-js-feature.yml@master
20 |
--------------------------------------------------------------------------------
/.github/workflows/staging.yml:
--------------------------------------------------------------------------------
1 | name: "CI / Staging"
2 |
3 | on:
4 | push:
5 | branches:
6 | - staging
7 | workflow_dispatch:
8 |
9 | concurrency:
10 | group: ${{ github.workflow }}-${{ github.ref }}
11 | cancel-in-progress: true
12 |
13 | jobs:
14 | use-library-js-staging:
15 | permissions:
16 | contents: write
17 | actions: write
18 | checks: write
19 | pull-requests: write
20 | uses: MatrixAI/.github/.github/workflows/library-js-staging.yml@master
21 | secrets:
22 | GH_TOKEN: ${{ secrets.GH_TOKEN }}
23 | GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
24 | GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}
25 | GIT_COMMITTER_EMAIL: ${{ secrets.GIT_COMMITTER_EMAIL }}
26 | GIT_COMMITTER_NAME: ${{ secrets.GIT_COMMITTER_NAME }}
27 |
28 |
--------------------------------------------------------------------------------
/.github/workflows/tag.yml:
--------------------------------------------------------------------------------
1 | name: "CI / Tag"
2 |
3 | on:
4 | push:
5 | tags:
6 | - 'v*.*.*'
7 | workflow_dispatch:
8 |
9 | jobs:
10 | use-library-js-tag:
11 | permissions:
12 | contents: read
13 | actions: write
14 | uses: MatrixAI/.github/.github/workflows/library-js-tag.yml@master
15 | secrets:
16 | NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
17 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /tmp
2 | /dist
3 | .env*
4 | !.env.example
5 | # nix
6 | /result*
7 | /builds
8 | # node-gyp
9 | /build
10 | # prebuildify
11 | /prebuilds
12 |
13 | # Logs
14 | logs
15 | *.log
16 | npm-debug.log*
17 | yarn-debug.log*
18 | yarn-error.log*
19 | lerna-debug.log*
20 |
21 | # Diagnostic reports (https://nodejs.org/api/report.html)
22 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
23 |
24 | # Runtime data
25 | pids
26 | *.pid
27 | *.seed
28 | *.pid.lock
29 |
30 | # Directory for instrumented libs generated by jscoverage/JSCover
31 | lib-cov
32 |
33 | # Coverage directory used by tools like istanbul
34 | coverage
35 | *.lcov
36 |
37 | # nyc test coverage
38 | .nyc_output
39 |
40 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
41 | .grunt
42 |
43 | # Bower dependency directory (https://bower.io/)
44 | bower_components
45 |
46 | # node-waf configuration
47 | .lock-wscript
48 |
49 | # Compiled binary addons (https://nodejs.org/api/addons.html)
50 | build/Release
51 |
52 | # Dependency directories
53 | node_modules/
54 | jspm_packages/
55 |
56 | # Snowpack dependency directory (https://snowpack.dev/)
57 | web_modules/
58 |
59 | # TypeScript cache
60 | *.tsbuildinfo
61 |
62 | # Optional npm cache directory
63 | .npm
64 |
65 | # Optional eslint cache
66 | .eslintcache
67 |
68 | # Microbundle cache
69 | .rpt2_cache/
70 | .rts2_cache_cjs/
71 | .rts2_cache_es/
72 | .rts2_cache_umd/
73 |
74 | # Optional REPL history
75 | .node_repl_history
76 |
77 | # Output of 'npm pack'
78 | *.tgz
79 |
80 | # Yarn Integrity file
81 | .yarn-integrity
82 |
83 | # dotenv environment variables file
84 | .env
85 | .env.test
86 |
87 | # parcel-bundler cache (https://parceljs.org/)
88 | .cache
89 | .parcel-cache
90 |
91 | # Next.js build output
92 | .next
93 | out
94 |
95 | # Nuxt.js build / generate output
96 | .nuxt
97 | dist
98 |
99 | # Gatsby files
100 | .cache/
101 | # Comment in the public line in if your project uses Gatsby and not Next.js
102 | # https://nextjs.org/blog/next-9-1#public-directory-support
103 | # public
104 |
105 | # vuepress build output
106 | .vuepress/dist
107 |
108 | # Serverless directories
109 | .serverless/
110 |
111 | # FuseBox cache
112 | .fusebox/
113 |
114 | # DynamoDB Local files
115 | .dynamodb/
116 |
117 | # TernJS port file
118 | .tern-port
119 |
120 | # Stores VSCode versions used for testing VSCode extensions
121 | .vscode-test
122 |
123 | # yarn v2
124 | .yarn/cache
125 | .yarn/unplugged
126 | .yarn/build-state.yml
127 | .yarn/install-state.gz
128 | .pnp.*
129 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | .*
2 | /*.nix
3 | /nix
4 | /tsconfig.json
5 | /tsconfig.build.json
6 | /jest.config.js
7 | /scripts
8 | /src
9 | /tests
10 | /tmp
11 | /docs
12 | /benches
13 | /build
14 | /builds
15 | /dist/tsbuildinfo
16 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # js-id
2 |
3 | ID generation for JavaScript & TypeScript applications.
4 |
5 | Example Usage:
6 |
7 | ```ts
8 | import { IdRandom, IdDeterministic, IdSortable, utils } from '@matrixai/id';
9 |
10 | // Random ids, equivalent to UUIDv4
11 |
12 | const randGen = new IdRandom();
13 |
14 | const randIds = [...utils.take(randGen, 3)];
15 | console.log(randIds.map((b) => utils.toUUID(b)));
16 |
17 | // Deterministic ids, equivalent to UUIDv5
18 |
19 | const deteGen = new IdDeterministic({
20 | namespace: 'foo',
21 | });
22 |
23 | const deteId1 = deteGen.get();
24 | const deteId2 = deteGen.get('bar');
25 | const deteId3 = deteGen.get('bar');
26 |
27 | console.log(utils.toUUID(deteId1));
28 | console.log(utils.toMultibase(deteId2, 'base32hex'));
29 |
30 | // Will be cast to string index
31 | const recordOfDeteIds = {};
32 | recordOfDeteIds[deteId1] = 1;
33 | recordOfDeteIds[deteId2] = 1;
34 | console.log(recordOfDeteIds[deteId1]);
35 |
36 | // Can be checked for equality
37 | console.log(deteId2.equals(deteId3));
38 | // Binary string form can be checked for equality
39 | console.log(deteId2.toString() === deteId3.toString());
40 |
41 | // Strictly monotonic sortable ids, equivalent to UUIDv7
42 |
43 | let lastId = new Uint8Array([
44 | 0x06, 0x16, 0x3e, 0xf5, 0x6d, 0x8d, 0x70, 0x00, 0x87, 0xc4, 0x65, 0xd5, 0x21,
45 | 0x9b, 0x03, 0xd4,
46 | ]);
47 |
48 | const sortGen = new IdSortable({ lastId });
49 |
50 | const sortId1 = sortGen.get();
51 | const sortId2 = sortGen.get();
52 | const sortId3 = sortGen.get();
53 |
54 | const sortIds = [
55 | utils.toBuffer(sortId2),
56 | utils.toBuffer(sortId3),
57 | utils.toBuffer(sortId1),
58 | ];
59 |
60 | sortIds.sort(Buffer.compare);
61 |
62 | console.log(sortIds);
63 |
64 | // Save the last id to ensure strict monotonicity across process restarts
65 | lastId = sortGen.lastId;
66 |
67 | // Ids can also be compared in order
68 | console.log(sortId1 < sortId2);
69 | console.log(sortId2 < sortId3);
70 | ```
71 |
72 | **Base Encoding and Lexicographic Order**
73 |
74 | It is important to realise that not all base-encodings preserve lexicographic
75 | sort order. The UUID (hex-encoding) and `base32hex` does, but `base58btc` and
76 | `base64` does not. Make sure to pick an appropriate base encoding if you are
77 | expecting to compare the `IdSortable` as base-encoded strings.
78 |
79 | Out of all the multibase encodings, the only ones that preserve sort order are:
80 |
81 | ```
82 | base2
83 | base8
84 | base16
85 | base16upper
86 | base32hex
87 | base32hexupper
88 | base32hexpad
89 | base32hexpadupper
90 | ```
91 |
92 | In addition to this, JS binary string encoding through `id.toString()` also
93 | preserves sort order.
94 |
95 | ## Installation
96 |
97 | ```sh
98 | npm install --save @matrixai/id
99 | ```
100 |
101 | ## Development
102 |
103 | Run `nix develop`, and once you're inside, you can use:
104 |
105 | ```sh
106 | # install (or reinstall packages from package.json)
107 | npm install
108 | # build the dist
109 | npm run build
110 | # run the repl (this allows you to import from ./src)
111 | npm run tsx
112 | # run the tests
113 | npm run test
114 | # lint the source code
115 | npm run lint
116 | # automatically fix the source
117 | npm run lintfix
118 | ```
119 |
120 | ### Docs Generation
121 |
122 | ```sh
123 | npm run docs
124 | ```
125 |
126 | See the docs at: https://matrixai.github.io/js-id/
127 |
128 | ### Publishing
129 |
130 | Publishing is handled automatically by the staging pipeline.
131 |
132 | Prerelease:
133 |
134 | ```sh
135 | # npm login
136 | npm version prepatch --preid alpha # premajor/preminor/prepatch
137 | git push --follow-tags
138 | ```
139 |
140 | Release:
141 |
142 | ```sh
143 | # npm login
144 | npm version patch # major/minor/patch
145 | git push --follow-tags
146 | ```
147 |
148 | Manually:
149 |
150 | ```sh
151 | # npm login
152 | npm version patch # major/minor/patch
153 | npm run build
154 | npm publish --access public
155 | git push
156 | git push --tags
157 | ```
158 |
--------------------------------------------------------------------------------
/docs/.nojekyll:
--------------------------------------------------------------------------------
1 | TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
--------------------------------------------------------------------------------
/docs/assets/highlight.css:
--------------------------------------------------------------------------------
1 | :root {
2 | --light-hl-0: #AF00DB;
3 | --dark-hl-0: #C586C0;
4 | --light-hl-1: #000000;
5 | --dark-hl-1: #D4D4D4;
6 | --light-hl-2: #001080;
7 | --dark-hl-2: #9CDCFE;
8 | --light-hl-3: #A31515;
9 | --dark-hl-3: #CE9178;
10 | --light-hl-4: #008000;
11 | --dark-hl-4: #6A9955;
12 | --light-hl-5: #0000FF;
13 | --dark-hl-5: #569CD6;
14 | --light-hl-6: #0070C1;
15 | --dark-hl-6: #4FC1FF;
16 | --light-hl-7: #795E26;
17 | --dark-hl-7: #DCDCAA;
18 | --light-hl-8: #098658;
19 | --dark-hl-8: #B5CEA8;
20 | --light-code-background: #FFFFFF;
21 | --dark-code-background: #1E1E1E;
22 | }
23 |
24 | @media (prefers-color-scheme: light) { :root {
25 | --hl-0: var(--light-hl-0);
26 | --hl-1: var(--light-hl-1);
27 | --hl-2: var(--light-hl-2);
28 | --hl-3: var(--light-hl-3);
29 | --hl-4: var(--light-hl-4);
30 | --hl-5: var(--light-hl-5);
31 | --hl-6: var(--light-hl-6);
32 | --hl-7: var(--light-hl-7);
33 | --hl-8: var(--light-hl-8);
34 | --code-background: var(--light-code-background);
35 | } }
36 |
37 | @media (prefers-color-scheme: dark) { :root {
38 | --hl-0: var(--dark-hl-0);
39 | --hl-1: var(--dark-hl-1);
40 | --hl-2: var(--dark-hl-2);
41 | --hl-3: var(--dark-hl-3);
42 | --hl-4: var(--dark-hl-4);
43 | --hl-5: var(--dark-hl-5);
44 | --hl-6: var(--dark-hl-6);
45 | --hl-7: var(--dark-hl-7);
46 | --hl-8: var(--dark-hl-8);
47 | --code-background: var(--dark-code-background);
48 | } }
49 |
50 | :root[data-theme='light'] {
51 | --hl-0: var(--light-hl-0);
52 | --hl-1: var(--light-hl-1);
53 | --hl-2: var(--light-hl-2);
54 | --hl-3: var(--light-hl-3);
55 | --hl-4: var(--light-hl-4);
56 | --hl-5: var(--light-hl-5);
57 | --hl-6: var(--light-hl-6);
58 | --hl-7: var(--light-hl-7);
59 | --hl-8: var(--light-hl-8);
60 | --code-background: var(--light-code-background);
61 | }
62 |
63 | :root[data-theme='dark'] {
64 | --hl-0: var(--dark-hl-0);
65 | --hl-1: var(--dark-hl-1);
66 | --hl-2: var(--dark-hl-2);
67 | --hl-3: var(--dark-hl-3);
68 | --hl-4: var(--dark-hl-4);
69 | --hl-5: var(--dark-hl-5);
70 | --hl-6: var(--dark-hl-6);
71 | --hl-7: var(--dark-hl-7);
72 | --hl-8: var(--dark-hl-8);
73 | --code-background: var(--dark-code-background);
74 | }
75 |
76 | .hl-0 { color: var(--hl-0); }
77 | .hl-1 { color: var(--hl-1); }
78 | .hl-2 { color: var(--hl-2); }
79 | .hl-3 { color: var(--hl-3); }
80 | .hl-4 { color: var(--hl-4); }
81 | .hl-5 { color: var(--hl-5); }
82 | .hl-6 { color: var(--hl-6); }
83 | .hl-7 { color: var(--hl-7); }
84 | .hl-8 { color: var(--hl-8); }
85 | pre, code { background: var(--code-background); }
86 |
--------------------------------------------------------------------------------
/docs/functions/idSortable.extractRand.html:
--------------------------------------------------------------------------------
1 | extractRand | @matrixai/id
2 |
IdInternal can be used as a string primitive 20 | This type hack (as a number) prevents TS from complaining 21 | See: https://github.com/microsoft/TypeScript/issues/4538
22 |