Skip to content

Commit 21b48e6

Browse files
coolaj86coolaj86
committed
feat: add JS version
1 parent 2b0c90b commit 21b48e6

File tree

8 files changed

+430
-1
lines changed

8 files changed

+430
-1
lines changed

‎.jshintrc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"browser": true,
3+
"node": true,
4+
"esversion": 11,
5+
"curly": true,
6+
"sub": true,
7+
"bitwise": false,
8+
9+
"eqeqeq": true,
10+
"forin": true,
11+
"freeze": true,
12+
"immed": true,
13+
"latedef": "nofunc",
14+
"nonbsp": true,
15+
"nonew": true,
16+
"plusplus": true,
17+
"undef": true,
18+
"unused": "vars",
19+
"maxdepth": 4,
20+
"maxstatements": 100,
21+
"maxcomplexity": 20
22+
}

‎.prettierignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
docs
2+
node_modules
3+
package.json
4+
package-lock.json

‎README.md‎

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ uuidv7 > uuidv7.txt
1717
# Table of Contents
1818

1919
- [Install](#install)
20+
- [In JavaScript](#javascript-version)
2021
- [UUIDv7 Spec](#uuidv7-spec)
2122
- [By the Characters](#by-the-characters)
2223
- [By the Bits](#by-the-bits)
23-
- [Build](#build)
24+
- [Zig Build](#build)
2425
- [License](#license)
2526

2627
# Install
@@ -40,6 +41,55 @@ tar xvf ./uuidv7-v1.0.0-"$b_triplet".tar.gz
4041
mv ./uuidv7 ~/bin/
4142
```
4243

44+
# JavaScript Version
45+
46+
Supports both `import` and `require`.
47+
48+
Extremely simple implementation that can be tuned for speed or memory
49+
efficiency.
50+
51+
```sh
52+
npm install --save @root/uuidv7
53+
```
54+
55+
High-level API:
56+
57+
```js
58+
import UUIDv7 from "@root/uuidv7";
59+
60+
let buffer = new Uint8Array(4096); // optional, if you need lots of UUIDs, and fast
61+
UUIDv7.setBytesBuffer(buffer);
62+
63+
UUIDv7.uuidv7();
64+
// 01922aa4-88ad-7cae-a517-a298a491d35c
65+
66+
UUIDv7.uuidv7Bytes();
67+
// Uint8Array(16) [ 1, 146, 42, 176, 37, 122, 114, 189
68+
// 172, 240, 1, 146, 42, 176, 37, 122 ]
69+
```
70+
71+
Low-level API:
72+
73+
```js
74+
let now = Date.now();
75+
let ms64 = BigInt(now);
76+
let bytes = new Uint8Array(16);
77+
let start = 0;
78+
globalThis.crypto.getRandomValues(bytes);
79+
80+
void UUIDv7.fill(bytes, start, ms64);
81+
82+
console.log(bytes);
83+
// Uint8Array(16) [ 1, 146, 42, 176, 37, 122, 114, 189
84+
// 172, 240, 1, 146, 42, 176, 37, 122 ]
85+
```
86+
87+
```js
88+
let uuidv7 = UUIDv7.format(bytes);
89+
console.log(uuidv7);
90+
// 01922aa4-88ad-7cae-a517-a298a491d35c
91+
```
92+
4393
# UUIDv7 Spec
4494

4595
## By the Characters

‎jsconfig.json‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig to read more about this file */
4+
5+
/* Projects */
6+
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7+
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8+
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
9+
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
10+
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11+
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12+
13+
/* Language and Environment */
14+
"target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15+
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16+
// "jsx": "preserve", /* Specify what JSX code is generated. */
17+
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
18+
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19+
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
20+
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21+
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
22+
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
23+
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24+
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25+
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
26+
27+
/* Modules */
28+
"module": "commonjs", /* Specify what module code is generated. */
29+
// "rootDir": "./", /* Specify the root folder within your source files. */
30+
"moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
31+
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
32+
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
33+
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
34+
"typeRoots": ["./typings","./node_modules/@types"], /* Specify multiple folders that act like './node_modules/@types'. */
35+
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
36+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
37+
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
38+
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
39+
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
40+
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
41+
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
42+
// "resolveJsonModule": true, /* Enable importing .json files. */
43+
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
44+
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
45+
46+
/* JavaScript Support */
47+
"allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
48+
"checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
49+
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
50+
51+
/* Emit */
52+
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
53+
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
54+
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
55+
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
56+
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
57+
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
58+
// "outDir": "./", /* Specify an output folder for all emitted files. */
59+
// "removeComments": true, /* Disable emitting comments. */
60+
"noEmit": true, /* Disable emitting files from a compilation. */
61+
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
62+
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
63+
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
64+
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
65+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
66+
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
67+
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
68+
// "newLine": "crlf", /* Set the newline character for emitting files. */
69+
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
70+
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
71+
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
72+
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
73+
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
74+
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
75+
76+
/* Interop Constraints */
77+
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
78+
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
79+
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
80+
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
81+
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
82+
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
83+
84+
/* Type Checking */
85+
"strict": true, /* Enable all strict type-checking options. */
86+
"noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
87+
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
88+
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
89+
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
90+
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
91+
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
92+
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
93+
"alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
94+
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
95+
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
96+
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
97+
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
98+
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
99+
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
100+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
101+
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
102+
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
103+
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
104+
105+
/* Completeness */
106+
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
107+
"skipLibCheck": true /* Skip type checking all .d.ts files. */
108+
},
109+
"include": [
110+
"*.js",
111+
"bin/**/*.js",
112+
"lib/**/*.js",
113+
"src/**/*.js"
114+
],
115+
"exclude": ["node_modules"]
116+
}

‎package-lock.json‎

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
"name": "@root/uuidv7",
3+
"version": "1.0.0",
4+
"description": "Radically simple (and efficient) UUIDv7 generation for Browsers, Node, Bun, etc (JavaScript)",
5+
"main": "uuidv7.js",
6+
"type": "module",
7+
"files": [
8+
"./uuidv7.js"
9+
],
10+
"scripts": {
11+
"test": "node uuidv7-test.js",
12+
"jshint": "npx -p jshint@2.x -- jshint -c ./.jshintrc ./*.js",
13+
"lint": "npm run jshint && npm run tsc",
14+
"prettier": "npx -p prettier@3.x -- prettier -w '**/*.{js,md}'",
15+
"fmt": "npm run prettier",
16+
"bump": "npm version -m \"chore(release): bump to v%s\"",
17+
"tsc": "npx -p typescript@5.x -- tsc -p ./jsconfig.json",
18+
"reexport-types": "npx -p jswt@1.x -- reexport",
19+
"prepublish": "npm run reexport-types"
20+
},
21+
"repository": {
22+
"type": "git",
23+
"url": "git+https://github.com/coolaj86/polyglot-uuidv7.git"
24+
},
25+
"keywords": [
26+
"uuid",
27+
"uuidv7",
28+
"ULID",
29+
"Uint8Array",
30+
"string",
31+
"id",
32+
"autoincrement"
33+
],
34+
"author": "AJ ONeal <aj@therootcompany.com> (https://therootcompany.com/)",
35+
"license": "SEE LICENSE IN LICENSE",
36+
"bugs": {
37+
"url": "https://github.com/coolaj86/polyglot-uuidv7/issues"
38+
},
39+
"homepage": "https://github.com/coolaj86/polyglot-uuidv7#readme"
40+
}

‎uuidv7-test.js‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
import UUIDv7 from "./uuidv7.js";
2+
3+
{
4+
let uuidv7 = UUIDv7.uuidv7();
5+
console.info(uuidv7);
6+
}
7+
8+
{
9+
let uuidv7 = UUIDv7.uuidv7();
10+
console.info(uuidv7);
11+
}
12+
13+
{
14+
let uuidv7 = UUIDv7.uuidv7();
15+
console.info(uuidv7);
16+
}
17+
18+
let bytes4k = new Uint8Array(4096);
19+
UUIDv7.setBytesBuffer(bytes4k);
20+
21+
{
22+
let uuidv7 = UUIDv7.uuidv7();
23+
console.info(uuidv7);
24+
}
25+
26+
{
27+
let uuidv7 = UUIDv7.uuidv7Bytes();
28+
console.info(UUIDv7._cursor, uuidv7);
29+
}
30+
31+
{
32+
let uuidv7 = UUIDv7.uuidv7Bytes();
33+
console.info(UUIDv7._cursor, uuidv7);
34+
}
35+
36+
{
37+
let uuidv7 = UUIDv7.uuidv7Bytes();
38+
console.info(UUIDv7._cursor, uuidv7);
39+
}
40+
41+
{
42+
let uuidv7 = UUIDv7.uuidv7();
43+
console.info(uuidv7);
44+
}

0 commit comments

Comments
 (0)