Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# 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: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
45 changes: 45 additions & 0 deletions .gitignore
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
126 changes: 126 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@

<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/descriptor"
/>
</a>

## typescript-package/descriptor

<!-- 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]

**Version:** v1.0.0-beta

A **lightweight** TypeScript library for property descriptor.

## Table of contents

- [Installation](#installation)
- [Api](#api)
- `AccessorDescriptor`
- `CommonDescriptor`
- `DataDescriptor`
- `Descriptor`
- `Descriptors`
- `PropertyDescriptorChain`
- [Contributing](#contributing)
- [Code of Conduct](code-of-conduct)
- [Git](#git)
- [Commit](#commit)
- [Versioning](#versioning)
- [License](#license)

## Installation

```bash
npm install @typescript-package/descriptor --save-peer
```

## Api

```typescript
import {
// Abstract.
CommonDescriptor,
// Class.
AccessorDescriptor,
DataDescriptor,
Descriptor,
Descriptors,
PropertyDescriptorChain,
} from '@typescript-package/descriptor';
```

## Contributing

Your contributions are **valued**! If you'd like to contribute, please feel **free** to submit a pull request. Help is always appreciated.

## Code of Conduct

By participating in this project, you agree to follow **[Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)**.

## GIT

### Commit

Please follow the following commit message conventions:

- [AngularJS Git Commit Message Conventions][git-commit-angular]
- [Karma Git Commit Msg][git-commit-karma]
- [Conventional Commits][git-commit-conventional]

### Versioning

The package follows [Semantic Versioning 2.0.0][git-semver] for all releases. The versioning format is:

**Given a version number MAJOR.MINOR.PATCH, increment the:**

- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

**FAQ**
How should I deal with revisions in the 0.y.z initial development phase?

> 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.

How do I know when to release 1.0.0?

> 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.

## License

MIT © typescript-package ([license][typescript-package-license])

<!-- This package: typescript-package -->
<!-- GitHub: badges -->
[typescript-package-badge-issues]: https://img.shields.io/github/issues/typescript-package/descriptor
[isscript-package-badge-forks]: https://img.shields.io/github/forks/typescript-package/descriptor
[typescript-package-badge-stars]: https://img.shields.io/github/stars/typescript-package/descriptor
[typescript-package-badge-license]: https://img.shields.io/github/license/typescript-package/descriptor
<!-- GitHub: badges links -->
[typescript-package-issues]: https://github.com/typescript-package/descriptor/issues
[typescript-package-forks]: https://github.com/typescript-package/descriptor/network
[typescript-package-license]: https://github.com/typescript-package/descriptor/blob/master/LICENSE
[typescript-package-stars]: https://github.com/typescript-package/descriptor/stargazers
<!-- This package -->

<!-- Package: typescript-package -->
<!-- npm -->
[typescript-package-npm-badge-svg]: https://badge.fury.io/js/@typescript-package%2Fdescriptor.svg
[typescript-package-npm-badge]: https://badge.fury.io/js/@typescript-package%2Fdescriptor

<!-- GIT -->
[git-semver]: http://semver.org/

<!-- GIT: commit -->
[git-commit-angular]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153
[git-commit-karma]: http://karma-runner.github.io/0.10/dev/git-commit-msg.html
[git-commit-conventional]: https://www.conventionalcommits.org/en/v1.0.0/
8 changes: 8 additions & 0 deletions ng-package.json
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/descriptor",
"lib": {
"entryFile": "src/public-api.ts"
},
"keepLifecycleScripts": true
}
112 changes: 112 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

48 changes: 48 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"name": "@typescript-package/descriptor",
"version": "1.0.0-beta",
"author": "wwwdev.io <dev@wwwdev.io>",
"description": "A lightweight TypeScript library for property descriptor.",
"license": "MIT",
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org"
},
"peerDependencies": {
"@typedly/callback": "^1.0.0-beta.4",
"@typedly/descriptor": "^2.0.0"
},
"scripts": {
"prepublishOnly": "npm run pkg && npm run clean",
"pkg": "npm pkg delete module dependencies",
"clean": "npm pkg delete scripts"
},
"repository": {
"type": "git",
"url": "git+https://github.com/typescript-package/descriptor.git"
},
"bugs": {
"url": "https://github.com/typescript-package/descriptor/issues"
},
"keywords": [
"@typescript-package",
"@typescript-package/descriptor",
"AccessorDescriptor",
"CommonDescriptor",
"DataDescriptor",
"Descriptor",
"Descriptors",
"PropertyDescriptorChain"
],
"funding": [
{
"type": "stripe",
"url": "https://donate.stripe.com/dR614hfDZcJE3wAcMM"
},
{
"type": "revolut",
"url": "https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29"
}
],
"sideEffects": false
}
Loading