1.0.0 • Published 4 years ago
delete-me-pleasee v1.0.0
:bulb: See CONFIGURE_TEMPLATE.md to configure this template. Then, remove the file and this advise.
:books: See complete documentation
An exhaustive description of the library.
:notebook: Summary
:package: Installation
- :cat2: Using Nest CLI:
nest add delete-me-pleasee
- :package: Using Package Manager:
npm install --save delete-me-pleasee
:wrench: Setup
Explain your library setup.
import { Module } from '@nestjs/common';
import { CatifyModule, LibraryNameConfig } from 'delete-me-pleasee';
const CONFIG: LibraryNameConfig = {
value: 'Awesome!'
}
@Module({
imports: [
...
CatifyModule.register(CONFIG)
],
controllers: [ ... ],
providers: [ ... ],
})
export class AppModule {}
:control_knobs: Config
Value | Type | Default | Description |
---|---|---|---|
value | string | <DEFAULT> | A powerful value |
:books: Usage
Explain your library usage.
CatifyService
A service with an awesome & helpul functionallity.
Method | Signature | Description |
---|---|---|
printConfig | config: LibraryNameConfig | Prints a provided configuration |
:art: Schematics
Invoke Schematics using:
nest g <schematic> [params] --collection delete-me-pleasee
demo
Prints a cute cat.
Parameter | Type | Default | Description |
---|---|---|---|
catType | string | Default | Type of cat to print. |
1.0.0
4 years ago