-
-
Notifications
You must be signed in to change notification settings - Fork 0
v0.0.1 #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
v0.0.1 #1
Changes from all commits
bd460e4
bbf8eb8
266e359
8541e7b
f4b00ec
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # These are supported funding model platforms | ||
|
|
||
| github: [angular-package] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] | ||
| patreon: angularpackage # Replace with a single Patreon username | ||
| open_collective: # Replace with a single Open Collective username | ||
| ko_fi: # Replace with a single Ko-fi username | ||
| tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
| community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
| liberapay: # Replace with a single Liberapay username | ||
| issuehunt: # Replace with a single IssueHunt username | ||
| otechie: # Replace with a single Otechie username | ||
| custom: [ | ||
| 'https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29', | ||
| 'https://donate.stripe.com/dR614hfDZcJE3wAcMM' | ||
| ] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # See https://docs.github.com/get-started/getting-started-with-git/ignoring-files for more about ignoring files. | ||
|
|
||
| # Compiled output | ||
| /dist | ||
| /tmp | ||
| /out-tsc | ||
| /bazel-out | ||
|
|
||
| # Node | ||
| /node_modules | ||
| npm-debug.log | ||
| yarn-error.log | ||
|
|
||
| # IDEs and editors | ||
| .idea/ | ||
| .project | ||
| .classpath | ||
| .c9/ | ||
| *.launch | ||
| .settings/ | ||
| *.sublime-workspace | ||
|
|
||
| # Visual Studio Code | ||
| .vscode/* | ||
| !.vscode/settings.json | ||
| !.vscode/tasks.json | ||
| !.vscode/launch.json | ||
| !.vscode/extensions.json | ||
| .history/* | ||
|
|
||
| # Miscellaneous | ||
| /.angular/cache | ||
| .sass-cache/ | ||
| /connect.lock | ||
| /coverage | ||
| /libpeerconnection.log | ||
| testem.log | ||
| /typings | ||
|
|
||
| # System files | ||
| .DS_Store | ||
| Thumbs.db | ||
|
|
||
| *.ignore* | ||
| temp |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,200 @@ | ||||||
| <a href="https://www.typescriptlang.org/"> | ||||||
| <img | ||||||
| src="https://raw.githubusercontent.com/typescript-package/core/refs/heads/main/ts-package-barcode-logo-512.png" | ||||||
| width="20%" | ||||||
| title="@typescript-package/collection - A lightweight TypeScript library for data collection." | ||||||
| /> | ||||||
| </a> | ||||||
|
|
||||||
| ## @typescript-package/collection | ||||||
|
|
||||||
| <!-- npm badge --> | ||||||
| [![npm version][typescript-package-npm-badge-svg]][typescript-package-npm-badge] | ||||||
| [![GitHub issues][typescript-package-badge-issues]][typescript-package-issues] | ||||||
| [![GitHub license][typescript-package-badge-license]][typescript-package-license] | ||||||
|
|
||||||
| A **lightweight** TypeScript package for data collection. | ||||||
|
|
||||||
| ## Table of contents | ||||||
|
|
||||||
| - [Installation](#installation) | ||||||
| - [Api](#api) | ||||||
| - **Abstract** | ||||||
| - [`CollectionBase`](#collectionbase) | ||||||
| - [`CollectionCore`](#collectioncore) | ||||||
| - **Adapters** | ||||||
| - [`SetAdapter`](#setadapter) | ||||||
| - **Concrete** | ||||||
| - [`Collection`](#collection) | ||||||
| - [Contributing](#contributing) | ||||||
| - [Code of Conduct](code-of-conduct) | ||||||
| - [Git](#git) | ||||||
| - [Commit](#commit) | ||||||
| - [Versioning](#versioning) | ||||||
| - [License](#license) | ||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| ```bash | ||||||
| npm install @typescript-package/collection --save-peer | ||||||
| ``` | ||||||
|
|
||||||
| ## Api | ||||||
|
|
||||||
| ```typescript | ||||||
| import { | ||||||
| // Abstract. | ||||||
| CollectionCore, | ||||||
| CollectionBase, | ||||||
| // Concrete. | ||||||
| Collection, | ||||||
| // Adapters. | ||||||
| SetAdapter | ||||||
| } from '@typescript-package/collection'; | ||||||
| ``` | ||||||
|
|
||||||
| ### Abstract | ||||||
|
|
||||||
| ### `CollectionBase` | ||||||
|
|
||||||
| The base functionality abstraction for collections. | ||||||
|
|
||||||
| ```typescript | ||||||
| import { CollectionBase } from '@typescript-package/collection'; | ||||||
| ``` | ||||||
|
|
||||||
| [`CollectionBase`](https://github.com/typescript-package/hooks/blob/main/src/core/lib/collection.base.ts) | ||||||
|
||||||
| [`CollectionBase`](https://github.com/typescript-package/hooks/blob/main/src/core/lib/collection.base.ts) | |
| [`CollectionBase`](https://github.com/typescript-package/collection/blob/main/src/core/lib/collection.base.ts) |
Copilot
AI
Dec 7, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect GitHub repository link. The URL points to typescript-package/hooks but should point to typescript-package/collection to match this repository.
Copilot
AI
Dec 7, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect GitHub repository link. The URL points to typescript-package/hooks but should point to typescript-package/collection to match this repository.
Copilot
AI
Dec 7, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect GitHub repository link and wrong file name. The URL points to typescript-package/hooks but should point to typescript-package/collection. Additionally, the file is named collection.class.ts, not collection.ts.
Copilot
AI
Dec 7, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo in badge reference name: isscript-package-badge-forks should be typescript-package-badge-forks.
| [isscript-package-badge-forks]: https://img.shields.io/github/forks/typescript-package/collection | |
| [typescript-package-badge-forks]: https://img.shields.io/github/forks/typescript-package/collection |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "$schema": "../../node_modules/ng-packagr/ng-package.schema.json", | ||
| "dest": "../../dist/collection", | ||
| "lib": { | ||
| "entryFile": "src/public-api.ts" | ||
| }, | ||
| "keepLifecycleScripts": true | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| { | ||
| "name": "@typescript-package/collection", | ||
| "version": "0.0.1", | ||
| "author": "wwwdev.io <dev@wwwdev.io>", | ||
| "description": "A lightweight TypeScript library for data collection.", | ||
| "license": "MIT", | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "registry": "https://registry.npmjs.org" | ||
| }, | ||
| "peerDependencies": { | ||
| "@typedly/collection": "^1.1.0" | ||
| }, | ||
| "scripts": { | ||
| "prepublishOnly": "npm run pkg && npm run clean", | ||
| "pkg": "npm pkg delete dependencies", | ||
| "clean": "npm pkg delete scripts" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/typescript-package/collection.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/typescript-package/collection/issues" | ||
| }, | ||
| "keywords": [ | ||
| "@typescript-package", | ||
| "@typescript-package/collection", | ||
| "CollectionBase", | ||
| "CollectionCore" | ||
| ], | ||
| "funding": [ | ||
| { | ||
| "type": "stripe", | ||
| "url": "https://donate.stripe.com/dR614hfDZcJE3wAcMM" | ||
| }, | ||
| { | ||
| "type": "individual", | ||
| "url": "https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29" | ||
| } | ||
| ], | ||
| "sideEffects": false | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing
#character in the link. This should be[Code of Conduct](#code-of-conduct)to properly link to the section.