-
Notifications
You must be signed in to change notification settings - Fork 0
/
.readme.hbs
112 lines (87 loc) · 2.96 KB
/
.readme.hbs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
[](https://bit.ly/2YFweqU)
[](https://bit.ly/2YFweqU)
[](https://bit.ly/3MUJErG)
[](https://bit.ly/2JYN1gk)
[](https://bit.ly/43aA0qF)
[](https://bit.ly/2LPRiVj)
[](https://bit.ly/2yP3kGa)
[](https://bit.ly/2yi7gyO)
Timeable Promise
================
Various asynchronous operations with timeout support.
Installation
-
```bash
$ yarn add timeable-promise
# or
$ npm install --save timeable-promise
```
API Reference
-
{{#module name="timeable-promise"}}
{{>body~}}
{{>member-index~}}
{{>separator~}}
{{>members~}}
{{/module}}
Development Dependencies
-
You will need to install [Node.js](https://bit.ly/2SMCGXK) as a local
development dependency. The `npm` package manager comes bundled with all
recent releases of `Node.js`. You can also use [yarn](https://bit.ly/3nmWS1K)
as a package manager.
`yarn` or `npm install` will attempt to resolve any `npm` module dependencies
that have been declared in the project’s `package.json` file, installing them
into the `node_modules` folder.
```bash
$ yarn
# or
$ npm install
```
Run Benchmark, Leak, Lint, and Unit Tests
-
To make sure we did not break anything, let's run all the tests:
```bash
$ yarn test
# or
$ npm run test:lint; npm run test:unit; npm run test:bench; npm run test:leak
```
Run benchmark tests only:
```bash
$ yarn test:bench
# or
$ npm run test:bench
```
Run leak tests only:
```bash
$ yarn test:leak
# or
$ npm run test:leak
```
Run lint tests only:
```bash
$ yarn test:lint
# or
$ npm run test:lint
```
Run unit tests only:
```bash
$ yarn test:unit
# or
$ npm run test:unit
```
Contributing
-
If you would like to contribute code to Timeable Promise repository you can do so
through GitHub by forking the repository and sending a pull request.
If you do not agree to [Contribution Agreement](CONTRIBUTING.md), do not
contribute any code to Timeable Promise repository.
When submitting code, please make every effort to follow existing conventions
and style in order to keep the code as readable as possible. Please also include
appropriate test cases.
That's it! Thank you for your contribution!
License
-
Copyright (c) 2018 - 2023 Richard Huang.
This module is free software, licensed under: [GNU Affero General Public License (AGPL-3.0)](https://bit.ly/2yi7gyO).
Documentation and other similar content are provided under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://bit.ly/2SMCRlS).