Skip to content

Commit 759d381

Browse files
authored
Merge pull request #1 from typescript-package/develop
v0.0.1
2 parents 61c78f1 + 99bbc2c commit 759d381

16 files changed

+729
-0
lines changed

.gitignore

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# See https://docs.github.com/get-started/getting-started-with-git/ignoring-files for more about ignoring files.
2+
3+
# Compiled output
4+
/dist
5+
/tmp
6+
/out-tsc
7+
/bazel-out
8+
9+
# Node
10+
/node_modules
11+
npm-debug.log
12+
yarn-error.log
13+
14+
# IDEs and editors
15+
.idea/
16+
.project
17+
.classpath
18+
.c9/
19+
*.launch
20+
.settings/
21+
*.sublime-workspace
22+
23+
# Visual Studio Code
24+
.vscode/*
25+
!.vscode/settings.json
26+
!.vscode/tasks.json
27+
!.vscode/launch.json
28+
!.vscode/extensions.json
29+
.history/*
30+
31+
# Miscellaneous
32+
/.angular/cache
33+
.sass-cache/
34+
/connect.lock
35+
/coverage
36+
/libpeerconnection.log
37+
testem.log
38+
/typings
39+
40+
# System files
41+
.DS_Store
42+
Thumbs.db
43+
44+
*.ignore*
45+
temp

README.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
2+
<a href="https://www.typescriptlang.org/">
3+
<img
4+
src="https://raw.githubusercontent.com/typescript-package/core/refs/heads/main/ts-package-barcode-logo-512.png"
5+
width="20%"
6+
title="@typescript-package/queue"
7+
/>
8+
</a>
9+
10+
## typescript-package/queue
11+
12+
A lightweight TypeScript library for managing various queue and stack structures.
13+
14+
<!-- npm badge -->
15+
[![npm version][typescript-package-npm-badge-svg]][typescript-package-npm-badge]
16+
[![GitHub issues][typescript-package-badge-issues]][typescript-package-issues]
17+
[![GitHub license][typescript-package-badge-license]][typescript-package-license]
18+
19+
<br>
20+
21+
## Table of contents
22+
23+
* [Installation](#installation)
24+
* [Api](#api)
25+
* `ProcessingQueue`
26+
* `Queue`
27+
* `Stack`
28+
* [Git](#git)
29+
* [Commit](#commit)
30+
* [Versioning](#versioning)
31+
* [License](#license)
32+
33+
## Installation
34+
35+
```bash
36+
npm install @typescript-package/queue
37+
```
38+
39+
## Api
40+
41+
```typescript
42+
import {
43+
ProcessingQueue,
44+
Queue,
45+
Stack
46+
} from '@typescript-package/queue';
47+
```
48+
49+
## GIT
50+
51+
### Commit
52+
53+
* [AngularJS Git Commit Message Conventions][git-commit-angular]
54+
* [Karma Git Commit Msg][git-commit-karma]
55+
* [Conventional Commits][git-commit-conventional]
56+
57+
### Versioning
58+
59+
[Semantic Versioning 2.0.0][git-semver]
60+
61+
**Given a version number MAJOR.MINOR.PATCH, increment the:**
62+
63+
* MAJOR version when you make incompatible API changes,
64+
* MINOR version when you add functionality in a backwards-compatible manner, and
65+
* PATCH version when you make backwards-compatible bug fixes.
66+
67+
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
68+
69+
**FAQ**
70+
How should I deal with revisions in the 0.y.z initial development phase?
71+
72+
> The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.
73+
74+
How do I know when to release 1.0.0?
75+
76+
> If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.
77+
78+
## License
79+
80+
MIT © typescript-package ([license][typescript-package-license])
81+
82+
<!-- This package: typescript-package -->
83+
<!-- GitHub: badges -->
84+
[typescript-package-badge-issues]: https://img.shields.io/github/issues/typescript-package/queue
85+
[isscript-package-badge-forks]: https://img.shields.io/github/forks/typescript-package/queue
86+
[typescript-package-badge-stars]: https://img.shields.io/github/stars/typescript-package/queue
87+
[typescript-package-badge-license]: https://img.shields.io/github/license/typescript-package/queue
88+
<!-- GitHub: badges links -->
89+
[typescript-package-issues]: https://github.com/typescript-package/queue/issues
90+
[typescript-package-forks]: https://github.com/typescript-package/queue/network
91+
[typescript-package-license]: https://github.com/typescript-package/queue/blob/master/LICENSE
92+
[typescript-package-stars]: https://github.com/typescript-package/queue/stargazers
93+
<!-- This package -->
94+
95+
<!-- Package: typescript-package -->
96+
<!-- npm -->
97+
[typescript-package-npm-badge-svg]: https://badge.fury.io/js/@typescript-package%2Fqueue.svg
98+
[typescript-package-npm-badge]: https://badge.fury.io/js/@typescript-package%2Fqueue
99+
100+
<!-- GIT -->
101+
[git-semver]: http://semver.org/
102+
103+
<!-- GIT: commit -->
104+
[git-commit-angular]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153
105+
[git-commit-karma]: http://karma-runner.github.io/0.10/dev/git-commit-msg.html
106+
[git-commit-conventional]: https://www.conventionalcommits.org/en/v1.0.0/

ng-package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
3+
"dest": "../../dist/queue",
4+
"lib": {
5+
"entryFile": "src/public-api.ts"
6+
},
7+
"keepLifecycleScripts": true
8+
}

package-lock.json

Lines changed: 90 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "@typescript-package/queue",
3+
"version": "0.0.1",
4+
"author": "wwwdev.io <dev@wwwdev.io>",
5+
"description": "A lightweight TypeScript library for managing various queue and stack structures.",
6+
"license": "MIT",
7+
"publishConfig": {
8+
"access": "public",
9+
"registry": "https://registry.npmjs.org"
10+
},
11+
"devDependencies": {},
12+
"peerDependencies": {
13+
"@typescript-package/state": "^2.0.0"
14+
},
15+
"scripts": {
16+
"prepublishOnly": "npm run pkg && npm run clean",
17+
"pkg": "npm pkg delete dependencies",
18+
"clean": "npm pkg delete scripts"
19+
},
20+
"repository": {
21+
"type": "git",
22+
"url": "git+https://github.com/typescript-package/queue.git"
23+
},
24+
"bugs": {
25+
"url": "https://github.com/typescript-package/queue/issues"
26+
},
27+
"keywords": [
28+
"@typescript-package",
29+
"@typescript-package/queue"
30+
],
31+
"funding": [
32+
{
33+
"type": "individual",
34+
"url": "https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29"
35+
}
36+
],
37+
"sideEffects": false
38+
}

src/lib/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export { ProcessingQueue } from './processing-queue.class';
2+
export { Queue } from './queue.abstract';
3+
export { Stack } from './stack.abstract';

0 commit comments

Comments
 (0)