Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xujif/async-hooks-map
A Thread-local storage (TLS) like Map implementation, base on node async hooks, support nodejs & typescript
https://github.com/xujif/async-hooks-map
async-hooks nodejs threadlocal typescript
Last synced: 17 days ago
JSON representation
A Thread-local storage (TLS) like Map implementation, base on node async hooks, support nodejs & typescript
- Host: GitHub
- URL: https://github.com/xujif/async-hooks-map
- Owner: xujif
- Created: 2018-04-20T10:51:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-11T11:09:25.000Z (over 6 years ago)
- Last Synced: 2024-11-17T11:14:14.487Z (about 1 month ago)
- Topics: async-hooks, nodejs, threadlocal, typescript
- Language: TypeScript
- Homepage:
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
[![NPM version][npm-image]][npm-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]
[![npm license][license-image]][download-url]
### A Thread-local storage (TLS) like Map implementation, base on node async hooks, support nodejs & typescript
- #### thread local support for nodejs & typescript
- #### named scope & chain support , easily to get closest forefather scope
- #### browser or lower version of node support if provided an async-hooks implementation with constructor
## install
```
npm install async-hooks-map
```
## import
```javascript
const { AsyncHookMap } = require('async-hooks-map')
```
## Usage
typescript:
```typescript
import { AsyncHookMap } from 'async-hooks-map'
// import asyncHookMap from 'async-hooks-map'
// import global instance which is lazy initialize
// Object.defineProperty(exports, 'default', {
// get () {}
// })
const scope = new AsyncHookMap()
Promise.resolve().then(() => {
scope.set('aa', 'first')
scope.alias('ccc')
assert.equal(scope.get('aa'), 'first')
return Promise.resolve().then(() => {
assert(scope.has('aa'), 'should has the key')
assert(!scope.has('not'), 'should not has the key')
assert(!scope.has('aa', false), 'should not has the key in this scope')
assert.equal(scope.get('aa'), 'first')
scope.set('aa', 'second')
assert.equal(scope.get('aa'), 'second')
}).then(() => {
assert.equal(scope.get('aa'), 'second')
assert.equal(scope.closest('ccc').get('aa'), 'first')
// 'root' as alias of 'ccc'
assert.equal(scope.closest('root').get('aa'), 'first')
scope.closest().delete('aa')
// parent scope 'aa' has been delete, 'aa' will be first
assert.equal(scope.get('aa'), 'first')
scope.closest('ccc').set('bb', 'bb')
assert.equal(scope.get('bb'), 'bb')
scope.delete('bb')
// can not be deleted ,because bb is set to "ccc" scope
assert.equal(scope.get('bb'), 'bb')
})
})
})
```
Api:
```typescript
export interface AsyncMapNode {
hasName (name: string): boolean
alias (name: string): this
parent (name?: string): AsyncMapNode | undefined
closest (name: string): AsyncMapNode
has (key: K, recurse?: boolean): boolean
get (key: K): V | undefined
set (key: K, value: V): this
clear (): void
delete (key: K): boolean
}
```
### tips
- closest(name:string) contains this and parent(name?:string) not
closest will throw when cant find the scope and parent() will return undefined
- A async scope can have multiple names
- Top async scope is named 'root' by default
[npm-image]: https://img.shields.io/npm/v/async-hooks-map.svg?style=flat-square
[npm-url]: https://npmjs.org/package/async-hooks-map
[travis-image]: https://img.shields.io/travis/https://github.com/xujif/async-hooks-map.svg?style=flat-square
[travis-url]: https://travis-ci.org/https://github.com/xujif/async-hooks-map
[coveralls-image]: https://img.shields.io/coveralls/https://github.com/xujif/async-hooks-map.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/https://github.com/xujif/async-hooks-map?branch=master
[david-image]: https://img.shields.io/david/https://github.com/xujif/async-hooks-map.svg?style=flat-square
[david-url]: https://david-dm.org/https://github.com/xujif/async-hooks-map
[node-image]: https://img.shields.io/badge/node.js-%3E=_8.6.0-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/async-hooks-map.svg?style=flat-square
[download-url]: https://npmjs.org/package/async-hooks-map
[license-image]: https://img.shields.io/npm/l/async-hooks-map.svg