https://github.com/matrixai/js-resources
Resource context management for TypeScript & JavaScript
https://github.com/matrixai/js-resources
bracket resource-management resources
Last synced: 11 months ago
JSON representation
Resource context management for TypeScript & JavaScript
- Host: GitHub
- URL: https://github.com/matrixai/js-resources
- Owner: MatrixAI
- License: apache-2.0
- Created: 2022-03-18T10:15:17.000Z (almost 4 years ago)
- Default Branch: staging
- Last Pushed: 2025-04-22T05:17:14.000Z (11 months ago)
- Last Synced: 2025-04-28T15:18:27.154Z (11 months ago)
- Topics: bracket, resource-management, resources
- Language: TypeScript
- Homepage: https://polykey.com
- Size: 601 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# js-resources
Resource context management inspired by Python's `with` context manager and Haskell's bracket pattern.
## Installation
```sh
npm install --save @matrixai/resources
```
## Development
Run `nix develop`, and once you're inside, you can use:
```sh
# install (or reinstall packages from package.json)
npm install
# build the dist
npm run build
# run the repl (this allows you to import from ./src)
npm run tsx
# run the tests
npm run test
# lint the source code
npm run lint
# automatically fix the source
npm run lintfix
```
### Docs Generation
```sh
npm run docs
```
See the docs at: https://matrixai.github.io/js-resources/
### Publishing
Publishing is handled automatically by the staging pipeline.
Prerelease:
```sh
# npm login
npm version prepatch --preid alpha # premajor/preminor/prepatch
git push --follow-tags
```
Release:
```sh
# npm login
npm version patch # major/minor/patch
git push --follow-tags
```
Manually:
```sh
# npm login
npm version patch # major/minor/patch
npm run build
npm publish --access public
git push
git push --tags