nx/docs/generated/packages/angular/generators/ngrx-root-store.json

80 lines
2.7 KiB
JSON

{
"name": "ngrx-root-store",
"factory": "./src/generators/ngrx-root-store/ngrx-root-store",
"schema": {
"$schema": "https://json-schema.org/schema",
"$id": "NxNgrxRootStoreGenerator",
"title": "Add NgRx support to an application.",
"description": "Adds NgRx support to an application.",
"cli": "nx",
"type": "object",
"properties": {
"project": {
"type": "string",
"description": "The name of the application to generate the NgRx configuration for.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What app would you like to generate a NgRx configuration for?",
"x-dropdown": "projects"
},
"minimal": {
"type": "boolean",
"default": true,
"description": "Only register the root state management setup or also generate a global feature state.",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "Name of the NgRx state, such as `products` or `users`. Recommended to use the plural form of the name.",
"x-priority": "important"
},
"route": {
"type": "string",
"description": "The route that the Standalone NgRx Providers should be added to.",
"default": "''"
},
"directory": {
"type": "string",
"default": "+state",
"description": "The name of the folder used to contain/group the generated NgRx files."
},
"facade": {
"type": "boolean",
"default": false,
"description": "Create a Facade class for the the feature.",
"x-prompt": "Would you like to use a Facade with your NgRx state?"
},
"addDevTools": {
"type": "boolean",
"default": false,
"description": "Instrument the Store Devtools."
},
"skipImport": {
"type": "boolean",
"default": false,
"description": "Generate NgRx feature files without registering the feature in the NgModule."
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not update the `package.json` with NgRx dependencies.",
"x-priority": "internal"
}
},
"additionalProperties": false,
"required": ["project"],
"presets": []
},
"description": "Adds an NgRx Root Store to an application.",
"implementation": "/packages/angular/src/generators/ngrx-root-store/ngrx-root-store.ts",
"aliases": [],
"hidden": false,
"path": "/packages/angular/src/generators/ngrx-root-store/schema.json",
"type": "generator"
}