Interface IApiOption

API定义

interface IApiOption {
    docs?: IDocOptions;
    forceGroup?: boolean;
    groups?: Record<string, string | IGroupInfoOpt>;
    info?: IApiOptionInfo;
    internalError?: ((msg) => Error);
    invalidParameterError?: ((msg) => Error);
    missingParameterError?: ((msg) => Error);
    path?: string;
}

Index

Properties

docs? forceGroup? groups? info? internalError? invalidParameterError? missingParameterError? path?

Properties

`Optional` docs

docs?: IDocOptions

`Optional` forceGroup

forceGroup?: boolean

`Optional` groups

groups?: Record<string, string | IGroupInfoOpt>

`Optional` info

info?: IApiOptionInfo

`Optional` internalError

internalError?: ((msg) => Error)

Type declaration

- (msg): Error
- Parameters
  - msg: string
  Returns Error

`Optional` invalidParameterError

invalidParameterError?: ((msg) => Error)

Type declaration

- (msg): Error
- Parameters
  - msg: string
  Returns Error

`Optional` missingParameterError

missingParameterError?: ((msg) => Error)

Type declaration

- (msg): Error
- Parameters
  - msg: string
  Returns Error

`Optional` path

path?: string

Generated using TypeDoc