Interface APIOption<T>

interface APIOption<T> {
    _allParams: Map<string, ISchemaType>;
    beforeHooks: Set<T>;
    examples: IExample[];
    group: string;
    middlewares: Set<T>;
    mock?: Record<string, any>;
    realPath: string;
    required: Set<string>;
    requiredOneOf: string[][];
    response?: TYPE_RESPONSE;
    responseSchema?: SchemaType | ISchemaType;
    tested: boolean;
}

Type Parameters

  • T

Hierarchy

  • Record<string, any>
    • APIOption

Properties

_allParams beforeHooks examples group middlewares mock? realPath required requiredOneOf response? responseSchema? tested

Properties

_allParams

_allParams: Map<string, ISchemaType>

beforeHooks

beforeHooks: Set<T>

examples

examples: IExample[]

group

group: string

middlewares

middlewares: Set<T>

Optional mock

mock?: Record<string, any>

realPath

realPath: string

required

required: Set<string>

requiredOneOf

requiredOneOf: string[][]

Optional response

response?: TYPE_RESPONSE

Optional responseSchema

responseSchema?: SchemaType | ISchemaType

tested

tested: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc