@nestjs/schematics

@nestjs/schematics

Version 11.1.0
Published 1 month ago
202 kB
5 dependencies
MIT license

Install

npm i @nestjs/schematics

yarn add @nestjs/schematics

pnpm add @nestjs/schematics

Overview

Nest - modern, fast, powerful node.js web framework (@schematics)

Variables

variable DEFAULT_APP_NAME

const DEFAULT_APP_NAME: string;

variable DEFAULT_APPS_PATH

const DEFAULT_APPS_PATH: string;

variable DEFAULT_AUTHOR

const DEFAULT_AUTHOR: string;

variable DEFAULT_DESCRIPTION

const DEFAULT_DESCRIPTION: string;

variable DEFAULT_DIR_ENTRY_APP

const DEFAULT_DIR_ENTRY_APP: string;

variable DEFAULT_LANGUAGE

const DEFAULT_LANGUAGE: string;

variable DEFAULT_LIB_PATH

const DEFAULT_LIB_PATH: string;

variable DEFAULT_PATH_NAME

const DEFAULT_PATH_NAME: string;

variable DEFAULT_VERSION

const DEFAULT_VERSION: string;

variable PROJECT_TYPE

const PROJECT_TYPE: { LIBRARY: string; APPLICATION: string };

variable TEST_ENV

const TEST_ENV: string;

Functions

function createModuleNameMapper

createModuleNameMapper: (
    packageKey: string,
    packageRoot: string
) => Record<string, string>;

function formatFiles

formatFiles: (paths?: Array<string | Path>) => Rule;

function inPlaceSortByKeys

inPlaceSortByKeys: (object: Record<string, any>) => Record<string, any>;

function isInRootDirectory

isInRootDirectory: (host: Tree, extraFiles?: string[]) => boolean;

function mergeSourceRoot

mergeSourceRoot: <T extends { sourceRoot?: string; path?: string } = any>(
    options: T
) => Rule;

function normalizeToKebabOrSnakeCase

normalizeToKebabOrSnakeCase: (str: string) => string;

Classes

class MetadataManager

class MetadataManager {}

constructor

constructor(content: string);

method insert

insert: (
    metadata: string,
    symbol: string,
    staticOptions?: DeclarationOptions['staticOptions']
) => string | undefined;

class ModuleDeclarator

class ModuleDeclarator {}

constructor

constructor(
    imports?: ModuleImportDeclarator,
    metadata?: ModuleMetadataDeclarator
);

method declare

declare: (content: string, options: DeclarationOptions) => string;

class ModuleFinder

class ModuleFinder {}

constructor

constructor(tree: Tree);

method find

find: (options: FindOptions) => Path | null;

class ModuleImportDeclarator

class ModuleImportDeclarator {}

constructor

constructor(solver?: PathSolver);

method declare

declare: (content: string, options: DeclarationOptions) => string;

class ModuleMetadataDeclarator

class ModuleMetadataDeclarator {}

method declare

declare: (content: string, options: DeclarationOptions) => string;

class NameParser

class NameParser {}

method parse

parse: (options: ParseOptions) => Location;

class PathSolver

class PathSolver {}

method relative

relative: (from: Path, to: Path) => string;

Interfaces

interface DeclarationOptions

interface DeclarationOptions {}

property className

className?: string;

property metadata

metadata: string;

property module

module: Path;

property name

name: string;

property path

path: Path;

property staticOptions

staticOptions?: {
    name: string;
    value: Record<string, any>;
};

property symbol

symbol?: string;

property type

type?: string;

interface FindOptions

interface FindOptions {}

property kind

kind?: string;

property name

name?: string;

property path

path: Path;

interface Location

interface Location {}

property name

name: string;

property path

path: Path;

interface ParseOptions

interface ParseOptions {}

property name

name: string;

property path

path?: string;

Package Files (14)

Dependencies (5)

Peer Dependencies (2)

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@nestjs/schematics.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@nestjs/schematics)

HTML

<a href="https://www.jsdocs.io/package/@nestjs/schematics"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 1 month ago.
Package analyzed in 3280 ms.
Missing or incorrect documentation? Open an issue for this package.

@nestjs/schematics

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Variables

variable DEFAULT_APP_NAME

variable DEFAULT_APPS_PATH

variable DEFAULT_AUTHOR

variable DEFAULT_DESCRIPTION

variable DEFAULT_DIR_ENTRY_APP

variable DEFAULT_LANGUAGE

variable DEFAULT_LIB_PATH

variable DEFAULT_PATH_NAME

variable DEFAULT_VERSION

variable PROJECT_TYPE

variable TEST_ENV

Functions

function createModuleNameMapper

function formatFiles

function inPlaceSortByKeys

function isInRootDirectory

function mergeSourceRoot

function normalizeToKebabOrSnakeCase

Classes

class MetadataManager

constructor

method insert

class ModuleDeclarator

constructor

method declare

class ModuleFinder

constructor

method find

class ModuleImportDeclarator

constructor

method declare

class ModuleMetadataDeclarator

method declare

class NameParser

method parse

class PathSolver

method relative

Interfaces

interface DeclarationOptions

property className

property metadata

property module

property name

property path

property staticOptions

property symbol

property type

interface FindOptions

property kind

property name

property path

interface Location

property name

property path

interface ParseOptions

property name

property path

Package Files (14)

Dependencies (5)

Dev Dependencies (25)

Peer Dependencies (2)

Badge