: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

• Installation
• Setup
• Usage
  • LibraryNameService
• Schematics

:package: Installation

• :cat2: Using Nest CLI:

nest add nestjs-library-starter

• :package: Using Package Manager:

npm install --save nestjs-library-starter

:wrench: Setup

Explain your library setup.

import { Module } from '@nestjs/common';
import { LibraryNameModule, LibraryNameConfig } from 'nestjs-library-starter';

const CONFIG: LibraryNameConfig = {
  value: 'Awesome!'
}

@Module({
  imports: [
    ...
    LibraryNameModule.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.

LibraryNameService

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 nestjs-library-starter

demo

Prints a cute cat.

| Parameter | Type | Default | Description | | --- | --- | --- | --- | | catType | string | Default | Type of cat to print.