Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remarkablemark/trieste
:evergreen_tree:Trie generator.
https://github.com/remarkablemark/trieste
javascript npm package trie trie-node trie-structure trie-tree tries
Last synced: 4 days ago
JSON representation
:evergreen_tree:Trie generator.
- Host: GitHub
- URL: https://github.com/remarkablemark/trieste
- Owner: remarkablemark
- License: mit
- Created: 2019-08-30T04:03:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-13T22:31:21.000Z (over 4 years ago)
- Last Synced: 2024-05-01T21:25:50.452Z (6 months ago)
- Topics: javascript, npm, package, trie, trie-node, trie-structure, trie-tree, tries
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/trieste
- Size: 54.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# trieste
[](https://nodei.co/npm/trieste/)
[](https://www.npmjs.com/package/trieste)
[](https://travis-ci.org/remarkablemark/trieste)
[](https://coveralls.io/github/remarkablemark/trieste?branch=master)
[Trie](https://wikipedia.org/wiki/Trie) generator.
[Repl.it](https://repl.it/@remarkablemark/trieste) | [JSFiddle](https://jsfiddle.net/remarkablemark/fjm2xyp0/) | [Examples](https://github.com/remarkablemark/trieste/tree/master/examples)
## Installation
[NPM](https://www.npmjs.com/package/trieste):
```sh
$ npm install trieste --save
```
[Yarn](https://yarnpkg.com/package/trieste):
```sh
$ yarn add trieste
```
[CDN](https://unpkg.com/trieste/):
```html
```
## Usage
### Module
Import the module:
```js
// CommonJS
const trieste = require('trieste');
// ES Modules
import trieste from 'trieste';
```
### Trie
Create a trie instance:
```js
const trie = trieste();
```
This can also be done by instantiating the constructor:
```js
const Trie = require('trieste/lib/trie');
const trie = new Trie();
```
#### Options
Options can be set for each instance:
```js
const options = {
endKey: 'END_OF_STRING_KEY',
endValue: 'END_OF_STRING_VALUE'
};
const trie = trieste(options);
```
This can also be achieved with the constructor:
```js
const Trie = require('trieste/lib/trie');
const trie = new Trie({
endKey: 'END_OF_STRING_KEY',
endValue: 'END_OF_STRING_VALUE'
});
```
Options are found on the instance's `options` property:
```js
trie.options;
```
The default options are:
```js
{
endKey: '$$',
endValue: 1
}
```
Options have a direct effect on the trie's [data](#data) and methods like [add](#add) and [get](#add).
#### Data
Data can be found on the instance's `data` property:
```js
trie.data;
```
Data is a POJO (Plain Old JavaScript Object), which means it can be converted to [JSON](https://www.json.org/):
```js
JSON.stringify(trie.data);
```
As an example, the following is the output of `trieste().add('a').data`:
```js
{ a: { '$$': 1 } }
```
### Methods
#### Add
Add a string to the trie:
```js
trie.add('foo');
```
Add multiple strings to the trie:
```js
trie.add('foo', 'bar');
```
Add an array of strings to the trie:
```js
trie.add.apply(trie, ['foo', 'bar']);
```
Add a string with a value to the trie:
```js
trie.add({ answer: 42 });
```
This is useful if you want to store value(s) other than the default. See method [get](#get) on how to retrieve a string value.
Since the method returns its own instance, method chaining is possible:
```js
trie.add('foo').add('bar');
```
Arguments that are not type `string` will be skipped.
#### Contains
Check if a string is found in the trie:
```js
trie.contains('foo');
```
The method returns a `boolean` value.
Arguments that are not type `string` will return `false`.
#### Get
Get a string value from the trie:
```js
trie.get('foo');
```
The value comes from `options.endValue`, which is `1` by default:
```js
trie.add('foo').get('foo'); // 1
```
The value can be set using the [add](#add) method:
```js
trie.add({ foo: 'bar' }).get('foo'); // 'bar'
```
The value can also be set in [options](#options):
```js
const trie = trieste({ endValue: null });
trie.add('foo').get('foo'); // null
```
Arguments that are not type `string` will return `undefined`.
#### Remove
Remove a string from the trie:
```js
trie.remove('foo');
```
Remove multiple strings from the trie:
```js
trie.remove('foo', 'bar');
```
Remove an array of strings from the trie:
```js
trie.remove.apply(trie, ['foo', 'bar']);
```
Since the method returns its own instance, method chaining is possible:
```js
trie.remove('foo').remove('bar');
```
Arguments that are not type `string` will be skipped.
## Testing
Run tests:
```sh
$ npm test
```
Run tests in watch mode:
```sh
$ npm run test:watch
```
Run tests with coverage:
```sh
$ npm run test:coverage
```
View coverage in browser:
```sh
$ npm run test:coverage:report
$ open coverage/index.html
```
Lint files:
```sh
$ npm run lint
```
Fix lint errors:
```sh
$ npm run lint:fix
```
## Release
Only collaborators with credentials can release and publish:
```sh
$ npm run release
$ git push --follow-tags && npm publish
```
## License
[MIT](https://github.com/remarkablemark/trieste/blob/master/LICENSE)