kibana/api_docs/kbn_xstate_utils.devdocs.json

{
  "id": "@kbn/xstate-utils",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/xstate-utils",
        "id": "def-common.createNotificationChannel",
        "type": "Function",
        "tags": [],
        "label": "createNotificationChannel",
        "description": [],
        "signature": [
          "<TContext, TEvent extends ",
          "EventObject",
          ", TSentEvent>(shouldReplayLastEvent?: boolean) => ",
          {
            "pluginId": "@kbn/xstate-utils",
            "scope": "common",
            "docId": "kibKbnXstateUtilsPluginApi",
            "section": "def-common.NotificationChannel",
            "text": "NotificationChannel"
          },
          "<TContext, TEvent, TSentEvent>"
        ],
        "path": "packages/kbn-xstate-utils/src/notification_channel.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/xstate-utils",
            "id": "def-common.createNotificationChannel.$1",
            "type": "boolean",
            "tags": [],
            "label": "shouldReplayLastEvent",
            "description": [],
            "signature": [
              "boolean"
            ],
            "path": "packages/kbn-xstate-utils/src/notification_channel.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/xstate-utils",
        "id": "def-common.isDevMode",
        "type": "Function",
        "tags": [],
        "label": "isDevMode",
        "description": [],
        "signature": [
          "() => boolean"
        ],
        "path": "packages/kbn-xstate-utils/src/dev_tools.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/xstate-utils",
        "id": "def-common.sendIfDefined",
        "type": "Function",
        "tags": [],
        "label": "sendIfDefined",
        "description": [],
        "signature": [
          "<TSentEvent extends ",
          "EventObject",
          " = ",
          "AnyEventObject",
          ">(target: string | ",
          "ActorRef",
          "<TSentEvent, any>) => <TContext, TEvent extends ",
          "EventObject",
          ">(eventExpr: ",
          "Expr",
          "<TContext, TEvent, TSentEvent | null | undefined>, options?: ",
          "SendActionOptions",
          "<TContext, TEvent> | undefined) => ",
          "PureAction",
          "<TContext, TEvent, TEvent>"
        ],
        "path": "packages/kbn-xstate-utils/src/actions.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/xstate-utils",
            "id": "def-common.sendIfDefined.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "target",
            "description": [],
            "signature": [
              "string | ",
              "ActorRef",
              "<TSentEvent, any>"
            ],
            "path": "packages/kbn-xstate-utils/src/actions.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/xstate-utils",
        "id": "def-common.NotificationChannel",
        "type": "Interface",
        "tags": [],
        "label": "NotificationChannel",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/xstate-utils",
            "scope": "common",
            "docId": "kibKbnXstateUtilsPluginApi",
            "section": "def-common.NotificationChannel",
            "text": "NotificationChannel"
          },
          "<TContext, TEvent, TSentEvent>"
        ],
        "path": "packages/kbn-xstate-utils/src/notification_channel.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/xstate-utils",
            "id": "def-common.NotificationChannel.createService",
            "type": "Function",
            "tags": [],
            "label": "createService",
            "description": [],
            "signature": [
              "() => ",
              "Subscribable",
              "<TSentEvent>"
            ],
            "path": "packages/kbn-xstate-utils/src/notification_channel.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/xstate-utils",
            "id": "def-common.NotificationChannel.notify",
            "type": "Function",
            "tags": [],
            "label": "notify",
            "description": [],
            "signature": [
              "(eventExpr: ",
              "Expr",
              "<TContext, TEvent, TSentEvent | undefined>) => (context: TContext, event: TEvent, meta: ",
              "ActionMeta",
              "<TContext, TEvent, ",
              "BaseActionObject",
              ">) => void"
            ],
            "path": "packages/kbn-xstate-utils/src/notification_channel.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/xstate-utils",
                "id": "def-common.NotificationChannel.notify.$1",
                "type": "Function",
                "tags": [],
                "label": "eventExpr",
                "description": [],
                "signature": [
                  "Expr",
                  "<TContext, TEvent, TSentEvent | undefined>"
                ],
                "path": "packages/kbn-xstate-utils/src/notification_channel.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/xstate-utils",
        "id": "def-common.MatchedState",
        "type": "Type",
        "tags": [],
        "label": "MatchedState",
        "description": [],
        "signature": [
          "TState extends ",
          "State",
          "<any, infer TEvent, infer TStateSchema, infer TTypestate, infer TResolvedTypesMeta> ? ",
          "State",
          "<(TTypestate extends any ? { value: TStateValue; context: any; } extends TTypestate ? TTypestate : never : never)[\"context\"], TEvent, TStateSchema, TTypestate, TResolvedTypesMeta> & { value: TStateValue; } : never"
        ],
        "path": "packages/kbn-xstate-utils/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/xstate-utils",
        "id": "def-common.MatchedStateFromActor",
        "type": "Type",
        "tags": [],
        "label": "MatchedStateFromActor",
        "description": [],
        "signature": [
          "EmittedFrom",
          "<TActorRef> extends ",
          "State",
          "<any, infer TEvent, infer TStateSchema, infer TTypestate, infer TResolvedTypesMeta> ? ",
          "State",
          "<(TTypestate extends any ? { value: TStateValue; context: any; } extends TTypestate ? TTypestate : never : never)[\"context\"], TEvent, TStateSchema, TTypestate, TResolvedTypesMeta> & { value: TStateValue; } : never"
        ],
        "path": "packages/kbn-xstate-utils/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/xstate-utils",
        "id": "def-common.OmitDeprecatedState",
        "type": "Type",
        "tags": [],
        "label": "OmitDeprecatedState",
        "description": [],
        "signature": [
          "{ [P in Exclude<keyof T, \"state\">]: T[P]; }"
        ],
        "path": "packages/kbn-xstate-utils/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}