@ngrx/schematics/src/effect/schema.json

NgRx Schematics for Angular

{
  "$schema": "http://json-schema.org/schema",
  "$id": "SchematicsNgRxEffect",
  "title": "NgRx Effect Options Schema",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the effect.",
      "type": "string",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What should be the name of the Effect?"
    },
    "path": {
      "type": "string",
      "format": "path",
      "description": "The path to create the component.",
      "visible": false,
      "$default": {
        "$source": "workingDirectory"
      }
    },
    "project": {
      "type": "string",
      "description": "The name of the project.",
      "aliases": ["p"]
    },
    "flat": {
      "type": "boolean",
      "default": true,
      "description": "Flag to indicate if a dir is created."
    },
    "skipTests": {
      "type": "boolean",
      "default": false,
      "description": "When true, does not create test files."
    },
    "module": {
      "type": "string",
      "default": "",
      "description": "Allows specification of the declaring module.",
      "alias": "m",
      "subtype": "filepath",
      "x-prompt": "To which module (path) should the effect be registered in?"
    },
    "root": {
      "type": "boolean",
      "default": false,
      "description": "Flag to indicate whether the effects are registered as root."
    },
    "feature": {
      "type": "boolean",
      "default": false,
      "description": "Flag to indicate if part of a feature schematic."
    },
    "group": {
      "type": "boolean",
      "default": false,
      "description": "Group effects file within 'effects' folder",
      "aliases": ["g"]
    },
    "api": {
      "type": "boolean",
      "default": false,
      "description": "Specifies if effect has api success and failure actions wired up",
      "aliases": ["a"],
      "x-prompt": "Should we wire up success and failure actions?"
    },
    "minimal": {
      "type": "boolean",
      "default": false,
      "description": "Setup root effects module without registering initial effects."
    },
    "prefix": {
      "description": "The prefix of the effect.",
      "type": "string",
      "default": "load",
      "x-prompt": "What should be the prefix of the effect?"
    }
  },
  "required": []
}