Interface IApiInfo<T>

API接口定义

interface IApiInfo<T> {
    $apis: Map<string, default<T>>;
    afterHooks: Set<T>;
    beforeHooks: Set<T>;
    define: ((opt) => default<T>);
    delete: ((path) => default<T>);
    docOutputForamt?: ((out) => any);
    docs?: default;
    formatOutputReverse?: ((out) => [null | Error, any]);
    get: ((path) => default<T>);
    patch: ((path) => default<T>);
    post: ((path) => default<T>);
    put: ((path) => default<T>);
}

Type Parameters

  • T

Hierarchy (view full)

Properties

$apis afterHooks beforeHooks define delete docOutputForamt? docs? formatOutputReverse? get patch post put

Properties

Readonly $apis

$apis: Map<string, default<T>>

afterHooks

afterHooks: Set<T>

beforeHooks

beforeHooks: Set<T>

define

define: ((opt) => default<T>)

Type declaration

    • (opt): default<T>

    • Parameters

      Returns default<T>

Readonly delete

delete: ((path) => default<T>)

Type declaration

    • (path): default<T>

    • Parameters

      • path: string

      Returns default<T>

Optional docOutputForamt

docOutputForamt?: ((out) => any)

Type declaration

    • (out): any

    • Parameters

      • out: any

      Returns any

Optional docs

docs?: default

Optional formatOutputReverse

formatOutputReverse?: ((out) => [null | Error, any])

Type declaration

    • (out): [null | Error, any]

    • Parameters

      • out: any

      Returns [null | Error, any]

Readonly get

get: ((path) => default<T>)

Type declaration

    • (path): default<T>

    • Parameters

      • path: string

      Returns default<T>

Readonly patch

patch: ((path) => default<T>)

Type declaration

    • (path): default<T>

    • Parameters

      • path: string

      Returns default<T>

Readonly post

post: ((path) => default<T>)

Type declaration

    • (path): default<T>

    • Parameters

      • path: string

      Returns default<T>

Readonly put

put: ((path) => default<T>)

Type declaration

    • (path): default<T>

    • Parameters

      • path: string

      Returns default<T>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc