Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ActionImplementor<Service, Params>

Representation of an action we implement

Type parameters

  • Service: string

  • Params = never

Hierarchy

  • { description: string; name: string; params?: CoreAndValidationSpecificationsMetaSchema; service: string; type: string | string[]; uischema?: undefined | {} }
    • ActionImplementor

Indexable

[k: string]: unknown

Representation of an action we implement

Index

Properties

Properties

callback

callback: (item: any, options: Params) => Promise<void>

A callback for code to implement this action

todo

Better types parameters?

Type declaration

    • (item: any, options: Params): Promise<void>

    • Parameters

      • item: any
      • options: Params

      Returns Promise<void>

Optional class

class: Params extends never ? never : { constructor: any }

Limit types of our parameters

MUST be a TypeScript class (i.e., not an interface or type) and MUST be named (i.e., not an anonymous class)

experimental

It is more stable and performant to provide params

see

params

description

description: string

Human description of the action for UI etc.

name

name: string

Name of the action

Optional params

params: CoreAndValidationSpecificationsMetaSchema

service

service: Service

Only implement our own actions

type

type: string | string[]

Content-type(s) with which this action works

Optional uischema

uischema: undefined | {}

Generated using TypeDoc