package
A Node.js Implementation of the Cloudflare Socket API
npm install @arrowood.dev/socketGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Estimated unpacked size across 1 packages.
12.2 kB
Includes dependencies.
A Node.js Implementation of the Cloudflare Socket API
npm i @arrowood.dev/socketRequirements:
The formatting, linting, and typechecking of this repo are based off of @vercel/style-guide.
This project uses TypeScript for building. This must be manually executed using:
pnpm buildOutput will be in the dist folder.
This project uses prettier for formatting. Code is formatted automatically when you commit, and you can run the formatter manually using:
pnpm formatAll files (except those listed in .prettierignore) will be formatted.
Prettier is configured by .prettierrc.js. It is based on @vercel/style-guide/prettier.
This project uses eslint for linting. Code is linted automatically when you commit, and you can run the linter manually using:
pnpm lintAll files (except those listed in .eslintignore) will be linted.
ESLint is configured by .eslintrc.js. It is based on @vercel/style-guide/eslint/node
This project uses node-tap for testing. Run tests using:
pnpm testOnly test files matching the pattern test/*.test.ts will be executed.
Testing utility functions should be stored in test/utils.ts and be well documented.
To manually type-check the repo without producing a build, use:
pnpm type-checkThis project uses TypeScript. There exists multiple TypeScript config files; each serves a different purpose.
test command, and the `type-check`` command.ethan_arrowood
ethan@arrowood.dev
src directorybuild command to output JavaScript