https://github.com/lordazzi/taipescripeto-singleton
A decorator to force classes generate only one instance
https://github.com/lordazzi/taipescripeto-singleton
angular decorator singleton ts typescript
Last synced: 2 months ago
JSON representation
A decorator to force classes generate only one instance
- Host: GitHub
- URL: https://github.com/lordazzi/taipescripeto-singleton
- Owner: lordazzi
- License: mit
- Created: 2020-04-23T18:21:00.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T04:18:13.000Z (over 3 years ago)
- Last Synced: 2025-10-31T03:07:59.177Z (8 months ago)
- Topics: angular, decorator, singleton, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 473 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Singleton
The Singleton Decorator to garantee
> taipescripeto singulus
[](https://badge.fury.io/js/%40taipescripeto%2Fsingleton)
[](https://travis-ci.org/lordazzi/taipescripeto-singleton)
[](https://github.com/lordazzi/taipescripeto-singleton/blob/master/LICENSE)
## Installation
```bash
npm install @taipescripeto/singleton --save
```
## Usage
This is a decorator @Singleton() to make you class single.
Compatible with most browsers, even old ones
```typescript
import { Singleton } from '@taipescripeto/singleton';
@Singleton()
class SomeBusinessService {
someBusinessRule(a: number, b: number): boolean {
return a < b;
}
}
// this return true
new SomeBusinessService() === new SomeBusinessService();
```
If you like an old school singleton implementation, you can do that:
```typescript
import { Singleton } from '@taipescripeto/singleton';
@Singleton()
class SomeBusinessService {
static getInstance() {
return new SomeBusinessService();
}
private constructor() { }
someBusinessRule(a: number, b: number): boolean {
return a < b;
}
}
// this return true
SomeBusinessService.getInstance() === SomeBusinessService.getInstance();
```
## Contributing
### 1. Create an issue
No one feature will be implemented without it having an open issue and without which the proposed has been accepted by the team responsible for the project. After the issue is approved, the applicant, a team member or anyone else can open a pull request associated with that issue (just paste the issue link in the pull request).
### 2. Did you find a bug?
When logging a bug, please be sure to include the following:
* The library version;
* If at all possible, an *isolated* way to reproduce the behavior;
* The behavior you expect to see, and the actual behavior.
You can try to update the library to the last version to see if the bug has already been fixed.
### 3. Do not create a duplicate issue
[Search the existing issues](https://github.com/lordazzi/taipescripeto-singleton/search?type=Issues) before logging a new one.
Some search tips:
* *Don't* restrict your search to only open issues. An issue with a title similar to yours may have been closed as a duplicate of one with a less-findable title.
* Check for synonyms. For example, if your bug involves an interface, it likely also occurs with type aliases or classes.
### 4. Create a Pull Request
Follow the steps:
* Create a [fork](https://guides.github.com/activities/forking/) from our repository, install [node](https://nodejs.org/), and run `npm install` in the application folder;
* Create a branch in your forked repository, then code the feature or fix the bug;
* Run `npm run lint`, `npm run test` and `npm run build` in the repository;
* Create a Pull Request from your repository to this one, with the issue in the body and some information you think could be usefull to the reviewer (print or a [gif of it working](https://www.screentogif.com/) will be appreciated);
* The reviewer can ask some changes, don't be mad, this is the GIT Flow process;
* You get approved and your branch with the feature / fix