diff --git a/classes/index.Alias.html b/classes/index.Alias.html index a3a3930..72adbd7 100644 --- a/classes/index.Alias.html +++ b/classes/index.Alias.html @@ -1,4 +1,4 @@ -Alias | @spailybot/moleculer-auto-openapi - v1.3.1

Class Alias

Constructors

constructor +Alias | @spailybot/moleculer-auto-openapi - v1.3.1

Class Alias

Constructors

constructor

Properties

_method _path action? @@ -16,4 +16,4 @@ getPaths isJokerAlias toJSON -

Constructors

constructor

Properties

Private _method

_method: rawHttpMethod = '*'

Private _path

_path: string = ''

Optional action

action?: string

Optional actionSchema

actionSchema?: Omit<ActionSchema, "openapi"> & {
    openapi?: ActionOpenApi;
} & {
    params?: ValidationSchema;
}

Type declaration

Type declaration

  • Optional params?: ValidationSchema

Optional Readonly busboyConfig

busboyConfig?: BusboyConfig<unknown>

fullPath

fullPath: string

openapi

openapi: undefined | AliasRouteOpenApi

Readonly route

route: Route

Optional service

service?: ServiceSchema<ServiceSettingSchema>

skipped

skipped: boolean = false

Optional type

type?: string

Accessors

method

path

Methods

getMethods

getPaths

isJokerAlias

toJSON

Settings

Member Visibility

Theme

On This Page

constructor_method_pathactionactionSchemabusboyConfigfullPathopenapirouteserviceskippedtypemethodpathgetMethodsgetPathsisJokerAliastoJSON
\ No newline at end of file +

Constructors

constructor

Properties

Private _method

_method: rawHttpMethod = '*'

Private _path

_path: string = ''

Optional action

action?: string

Optional actionSchema

actionSchema?: Omit<ActionSchema, "openapi"> & {
    openapi?: ActionOpenApi;
} & {
    params?: ValidationSchema;
}

Type declaration

Type declaration

  • Optional params?: ValidationSchema

Optional Readonly busboyConfig

busboyConfig?: BusboyConfig<unknown>

fullPath

fullPath: string

openapi

openapi: undefined | AliasRouteOpenApi

Readonly route

route: Route

Optional service

service?: ServiceSchema<ServiceSettingSchema>

skipped

skipped: boolean = false

Optional type

type?: string

Accessors

method

path

Methods

getMethods

getPaths

isJokerAlias

toJSON

Settings

Member Visibility

Theme

On This Page

constructor_method_pathactionactionSchemabusboyConfigfullPathopenapirouteserviceskippedtypemethodpathgetMethodsgetPathsisJokerAliastoJSON
\ No newline at end of file diff --git a/classes/index.PathAction.html b/classes/index.PathAction.html index c628a03..2f07e82 100644 --- a/classes/index.PathAction.html +++ b/classes/index.PathAction.html @@ -1,4 +1,4 @@ -PathAction | @spailybot/moleculer-auto-openapi - v1.3.1

Class PathAction

Constructors

constructor +PathAction | @spailybot/moleculer-auto-openapi - v1.3.1

Class PathAction

Constructors

constructor

Properties

action? actionName? actionType? @@ -7,4 +7,4 @@ path

Accessors

fullPath

Methods

setAction -

Constructors

constructor

Properties

Optional action

action?: ActionSchema

Optional actionName

actionName?: string

Optional actionType

actionType?: string

Private alias

alias: Alias

method

method: HTTP_METHODS

path

path: string

Accessors

fullPath

Methods

setAction

Settings

Member Visibility

Theme

On This Page

constructoractionactionNameactionTypealiasmethodpathfullPathsetAction
\ No newline at end of file +

Constructors

constructor

Properties

Optional action

action?: ActionSchema

Optional actionName

actionName?: string

Optional actionType

actionType?: string

Private alias

alias: Alias

method

method: HTTP_METHODS

path

path: string

Accessors

fullPath

Methods

setAction

Settings

Member Visibility

Theme

On This Page

constructoractionactionNameactionTypealiasmethodpathfullPathsetAction
\ No newline at end of file diff --git a/classes/index.Route.html b/classes/index.Route.html index ec1c472..1365798 100644 --- a/classes/index.Route.html +++ b/classes/index.Route.html @@ -1,4 +1,4 @@ -Route | @spailybot/moleculer-auto-openapi - v1.3.1

Class Route

Constructors

constructor +Route | @spailybot/moleculer-auto-openapi - v1.3.1

Class Route

Constructors

constructor

Properties

aliases apiService autoAliases @@ -11,4 +11,4 @@ skipUnresolvedActions

Methods

searchAlias formatPath -

Constructors

constructor

Properties

Readonly aliases

aliases: Alias[]

Readonly apiService

apiService: ServiceSchema<ApiSettingsSchemaOpenApi>

Readonly autoAliases

autoAliases: boolean

Optional Readonly bodyParsers

bodyParsers?: boolean | bodyParserOptions

Optional Readonly busboyConfig

busboyConfig?: BusboyConfig<unknown>

Private Readonly logger

logger: LoggerInstance

Optional Readonly openApiService

openApiService?: ServiceSchema<OpenApiMixinSettings>

Optional Readonly openapi

openapi?: ApiRouteOpenApi

Readonly path

path: string

Private Readonly skipUnresolvedActions

skipUnresolvedActions: boolean = true

Methods

searchAlias

Static formatPath

Settings

Member Visibility

Theme

On This Page

constructoraliasesapiServiceautoAliasesbodyParsersbusboyConfigloggeropenApiServiceopenapipathskipUnresolvedActionssearchAliasformatPath
\ No newline at end of file +

Constructors

constructor

Properties

Readonly aliases

aliases: Alias[]

Readonly apiService

apiService: ServiceSchema<ApiSettingsSchemaOpenApi>

Readonly autoAliases

autoAliases: boolean

Optional Readonly bodyParsers

bodyParsers?: boolean | bodyParserOptions

Optional Readonly busboyConfig

busboyConfig?: BusboyConfig<unknown>

Private Readonly logger

logger: LoggerInstance

Optional Readonly openApiService

openApiService?: ServiceSchema<OpenApiMixinSettings>

Optional Readonly openapi

openapi?: ApiRouteOpenApi

Readonly path

path: string

Private Readonly skipUnresolvedActions

skipUnresolvedActions: boolean = true

Methods

searchAlias

Static formatPath

Settings

Member Visibility

Theme

On This Page

constructoraliasesapiServiceautoAliasesbodyParsersbusboyConfigloggeropenApiServiceopenapipathskipUnresolvedActionssearchAliasformatPath
\ No newline at end of file diff --git a/enums/index.ECacheMode.html b/enums/index.ECacheMode.html index 45b781e..7e79a1d 100644 --- a/enums/index.ECacheMode.html +++ b/enums/index.ECacheMode.html @@ -1,5 +1,5 @@ ECacheMode | @spailybot/moleculer-auto-openapi - v1.3.1

Enumeration ECacheMode

Enum to describe the different cache modes.

-

Enumeration Members

NEXT_CALL +

Enumeration Members

NEXT_CALL REFRESH TIMEOUT

Enumeration Members

NEXT_CALL

NEXT_CALL: "next-call"

Cache Mode: NEXT_CALL

@@ -11,7 +11,7 @@
  • The first call might be a bit slower due to updating process.
-

REFRESH

REFRESH: "refresh"

Cache Mode: REFRESH

+

REFRESH

REFRESH: "refresh"

Cache Mode: REFRESH

Pro(s):

  • Provides faster response on the first call because cache regenerates whenever a new service is detected.
    • @@ -20,7 +20,7 @@
    • More CPU usage, often significantly, if aliases/services are refreshed frequently.
    -

TIMEOUT

TIMEOUT: "timeout"

Cache Mode: TIMEOUT

+

TIMEOUT

TIMEOUT: "timeout"

Cache Mode: TIMEOUT

Pro(s):

  • Designed mindful of CPU usage, it only clears cache on timeouts (default 10 mins).
    • @@ -30,4 +30,4 @@
  • Not ideal for dynamic servers due to its completely time-based cache clearing policy.
  • The OpenAPI might not be up-to-date all the time.
-

Settings

Member Visibility

Theme

On This Page

NEXT_CALLREFRESHTIMEOUT
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

NEXT_CALLREFRESHTIMEOUT
\ No newline at end of file diff --git a/enums/index.HTTP_METHODS.html b/enums/index.HTTP_METHODS.html index 8485174..597db6f 100644 --- a/enums/index.HTTP_METHODS.html +++ b/enums/index.HTTP_METHODS.html @@ -1,4 +1,4 @@ -HTTP_METHODS | @spailybot/moleculer-auto-openapi - v1.3.1

Enumeration HTTP_METHODS

Enumeration Members

DELETE +HTTP_METHODS | @spailybot/moleculer-auto-openapi - v1.3.1

Enumeration HTTP_METHODS

Enumeration Members

DELETE GET HEAD OPTIONS @@ -6,4 +6,4 @@ POST PUT TRACE -

Enumeration Members

DELETE

DELETE: "delete"

GET

GET: "get"

HEAD

HEAD: "head"

OPTIONS

OPTIONS: "options"

PATCH

PATCH: "patch"

POST

POST: "post"

PUT

PUT: "put"

TRACE

TRACE: "trace"

Settings

Member Visibility

Theme

On This Page

DELETEGETHEADOPTIONSPATCHPOSTPUTTRACE
\ No newline at end of file +

Enumeration Members

DELETE

DELETE: "delete"

GET

GET: "get"

HEAD

HEAD: "head"

OPTIONS

OPTIONS: "options"

PATCH

PATCH: "patch"

POST

POST: "post"

PUT

PUT: "put"

TRACE

TRACE: "trace"

Settings

Member Visibility

Theme

On This Page

DELETEGETHEADOPTIONSPATCHPOSTPUTTRACE
\ No newline at end of file diff --git a/interfaces/index.ActionOpenApi.html b/interfaces/index.ActionOpenApi.html index e955d64..ab02e5a 100644 --- a/interfaces/index.ActionOpenApi.html +++ b/interfaces/index.ActionOpenApi.html @@ -1,4 +1,4 @@ -ActionOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ActionOpenApi

interface ActionOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    operationId?: string;
    parameters?: (Omit<ParameterObject, "in"> & {
        in: "cookie" | "header";
    } & (Required<Pick<ParameterObject, "schema">> | Required<Pick<ParameterObject, "content">>))[];
    pathParameters?: Omit<ParameterObject, "in">[];
    queryParameters?: Omit<ParameterObject, "in">[];
    requestBody?: RequestBodyObject;
    response?: MediaTypeObject | actionOpenApiResponse;
    responses?: OptionalOrFalse<ResponsesObject>;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? +ActionOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ActionOpenApi

interface ActionOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    operationId?: string;
    parameters?: (Omit<ParameterObject, "in"> & {
        in: "cookie" | "header";
    } & (Required<Pick<ParameterObject, "schema">> | Required<Pick<ParameterObject, "content">>))[];
    pathParameters?: Omit<ParameterObject, "in">[];
    queryParameters?: Omit<ParameterObject, "in">[];
    requestBody?: RequestBodyObject;
    response?: MediaTypeObject | actionOpenApiResponse;
    responses?: OptionalOrFalse<ResponsesObject>;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? deprecated? description? externalDocs? @@ -13,23 +13,23 @@ servers? summary? tags? -

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

-

Optional description

description?: string

add a description to this operation

-

Optional externalDocs

externalDocs?: ExternalDocumentationObject

add an external documentation to this operation

-

Optional operationId

operationId?: string

add an operation id to this operation

-

Optional parameters

parameters?: (Omit<ParameterObject, "in"> & {
    in: "cookie" | "header";
} & (Required<Pick<ParameterObject, "schema">> | Required<Pick<ParameterObject, "content">>))[]

allow to pass header or cookies parameters

-

Optional pathParameters

pathParameters?: Omit<ParameterObject, "in">[]

allow to bypass the query generation from params . Specify it yourself

-

Optional queryParameters

queryParameters?: Omit<ParameterObject, "in">[]

allow to bypass the query generation from params . Specify it yourself

-

Optional requestBody

requestBody?: RequestBodyObject

allow to bypass the generation from params . Specify it yourself

-

Optional response

response?: MediaTypeObject | actionOpenApiResponse

can be used to fastly declare the 200 answer +

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

+

Optional description

description?: string

add a description to this operation

+

Optional externalDocs

externalDocs?: ExternalDocumentationObject

add an external documentation to this operation

+

Optional operationId

operationId?: string

add an operation id to this operation

+

Optional parameters

parameters?: (Omit<ParameterObject, "in"> & {
    in: "cookie" | "header";
} & (Required<Pick<ParameterObject, "schema">> | Required<Pick<ParameterObject, "content">>))[]

allow to pass header or cookies parameters

+

Optional pathParameters

pathParameters?: Omit<ParameterObject, "in">[]

allow to bypass the query generation from params . Specify it yourself

+

Optional queryParameters

queryParameters?: Omit<ParameterObject, "in">[]

allow to bypass the query generation from params . Specify it yourself

+

Optional requestBody

requestBody?: RequestBodyObject

allow to bypass the generation from params . Specify it yourself

+

Optional response

response?: MediaTypeObject | actionOpenApiResponse

can be used to fastly declare the 200 answer can be directly a Media Type Object so it will reuse the default contentType or an object specifying the type and the media

-

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . +

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . Merged by levels

-

Optional security

security?: SecurityRequirementObject[]

specify the security needed to call this endpoint

-

Optional servers

servers?: ServerObject[]

add a list of servers to this operation

-

Optional summary

summary?: string

add a summary to this operation

-

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

+

Optional security

security?: SecurityRequirementObject[]

specify the security needed to call this endpoint

+

Optional servers

servers?: ServerObject[]

add a list of servers to this operation

+

Optional summary

summary?: string

add a summary to this operation

+

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

  • Use a tagObject to define it ( follow by his name to use it )
  • use null to remove all tags added previously (by merge from other levels)
    • @@ -43,4 +43,4 @@

    Example

    // remove pare

    Example

    // add tag with description, and use it on children
    {
     tags: [
         {
            name: "tags1";
            description: "this is the first example tag";
            externalDocs: "https://doc.example.com/tags/tags1";
         },
         'tags1'
     ]
    }
    -

Settings

Member Visibility

Theme

On This Page

componentsdeprecateddescriptionexternalDocsoperationIdparameterspathParametersqueryParametersrequestBodyresponseresponsessecurityserverssummarytags
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

componentsdeprecateddescriptionexternalDocsoperationIdparameterspathParametersqueryParametersrequestBodyresponseresponsessecurityserverssummarytags
\ No newline at end of file diff --git a/interfaces/index.AliasRouteOpenApi.html b/interfaces/index.AliasRouteOpenApi.html index c7a13d1..dc370e3 100644 --- a/interfaces/index.AliasRouteOpenApi.html +++ b/interfaces/index.AliasRouteOpenApi.html @@ -1,4 +1,4 @@ -AliasRouteOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface AliasRouteOpenApi

interface AliasRouteOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    operationId?: string;
    parameters?: (Omit<ParameterObject, "in"> & {
        in: "cookie" | "header";
    } & (Required<Pick<ParameterObject, "schema">> | Required<Pick<ParameterObject, "content">>))[];
    pathParameters?: Omit<ParameterObject, "in">[];
    queryParameters?: Omit<ParameterObject, "in">[];
    requestBody?: RequestBodyObject;
    response?: MediaTypeObject | actionOpenApiResponse;
    responses?: OptionalOrFalse<ResponsesObject>;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? +AliasRouteOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface AliasRouteOpenApi

interface AliasRouteOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    operationId?: string;
    parameters?: (Omit<ParameterObject, "in"> & {
        in: "cookie" | "header";
    } & (Required<Pick<ParameterObject, "schema">> | Required<Pick<ParameterObject, "content">>))[];
    pathParameters?: Omit<ParameterObject, "in">[];
    queryParameters?: Omit<ParameterObject, "in">[];
    requestBody?: RequestBodyObject;
    response?: MediaTypeObject | actionOpenApiResponse;
    responses?: OptionalOrFalse<ResponsesObject>;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? deprecated? description? externalDocs? @@ -13,23 +13,23 @@ servers? summary? tags? -

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

-

Optional description

description?: string

add a description to this operation

-

Optional externalDocs

externalDocs?: ExternalDocumentationObject

add an external documentation to this operation

-

Optional operationId

operationId?: string

add an operation id to this operation

-

Optional parameters

parameters?: (Omit<ParameterObject, "in"> & {
    in: "cookie" | "header";
} & (Required<Pick<ParameterObject, "schema">> | Required<Pick<ParameterObject, "content">>))[]

allow to pass header or cookies parameters

-

Optional pathParameters

pathParameters?: Omit<ParameterObject, "in">[]

allow to bypass the query generation from params . Specify it yourself

-

Optional queryParameters

queryParameters?: Omit<ParameterObject, "in">[]

allow to bypass the query generation from params . Specify it yourself

-

Optional requestBody

requestBody?: RequestBodyObject

allow to bypass the generation from params . Specify it yourself

-

Optional response

response?: MediaTypeObject | actionOpenApiResponse

can be used to fastly declare the 200 answer +

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

+

Optional description

description?: string

add a description to this operation

+

Optional externalDocs

externalDocs?: ExternalDocumentationObject

add an external documentation to this operation

+

Optional operationId

operationId?: string

add an operation id to this operation

+

Optional parameters

parameters?: (Omit<ParameterObject, "in"> & {
    in: "cookie" | "header";
} & (Required<Pick<ParameterObject, "schema">> | Required<Pick<ParameterObject, "content">>))[]

allow to pass header or cookies parameters

+

Optional pathParameters

pathParameters?: Omit<ParameterObject, "in">[]

allow to bypass the query generation from params . Specify it yourself

+

Optional queryParameters

queryParameters?: Omit<ParameterObject, "in">[]

allow to bypass the query generation from params . Specify it yourself

+

Optional requestBody

requestBody?: RequestBodyObject

allow to bypass the generation from params . Specify it yourself

+

Optional response

response?: MediaTypeObject | actionOpenApiResponse

can be used to fastly declare the 200 answer can be directly a Media Type Object so it will reuse the default contentType or an object specifying the type and the media

-

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . +

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . Merged by levels

-

Optional security

security?: SecurityRequirementObject[]

specify the security needed to call this endpoint

-

Optional servers

servers?: ServerObject[]

add a list of servers to this operation

-

Optional summary

summary?: string

add a summary to this operation

-

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

+

Optional security

security?: SecurityRequirementObject[]

specify the security needed to call this endpoint

+

Optional servers

servers?: ServerObject[]

add a list of servers to this operation

+

Optional summary

summary?: string

add a summary to this operation

+

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

  • Use a tagObject to define it ( follow by his name to use it )
  • use null to remove all tags added previously (by merge from other levels)
    • @@ -43,4 +43,4 @@

    Example

    // remove pare

    Example

    // add tag with description, and use it on children
    {
     tags: [
         {
            name: "tags1";
            description: "this is the first example tag";
            externalDocs: "https://doc.example.com/tags/tags1";
         },
         'tags1'
     ]
    }
    -

Settings

Member Visibility

Theme

On This Page

componentsdeprecateddescriptionexternalDocsoperationIdparameterspathParametersqueryParametersrequestBodyresponseresponsessecurityserverssummarytags
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

componentsdeprecateddescriptionexternalDocsoperationIdparameterspathParametersqueryParametersrequestBodyresponseresponsessecurityserverssummarytags
\ No newline at end of file diff --git a/interfaces/index.AliasRouteSchemaOpenApi.html b/interfaces/index.AliasRouteSchemaOpenApi.html index a050ecc..eaed89a 100644 --- a/interfaces/index.AliasRouteSchemaOpenApi.html +++ b/interfaces/index.AliasRouteSchemaOpenApi.html @@ -1,7 +1,7 @@ AliasRouteSchemaOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface AliasRouteSchemaOpenApi

moleculer-web AliasRouteSchema is a type, so not extendable

Example

//you can use this in your aliases
{
  aliases: {
    'POST go': {} as AliasRouteSchemaOpenApi
  }
}
-
interface AliasRouteSchemaOpenApi {
    action?: string;
    busboyConfig?: BusboyConfig<unknown>;
    except?: string[];
    handler?: unknown;
    method?: string;
    only?: string[];
    openapi?: false | AliasRouteOpenApi;
    path?: string;
    type?: string;
}

Hierarchy (view full)

Properties

action? +
interface AliasRouteSchemaOpenApi {
    action?: string;
    busboyConfig?: BusboyConfig<unknown>;
    except?: string[];
    handler?: unknown;
    method?: string;
    only?: string[];
    openapi?: false | AliasRouteOpenApi;
    path?: string;
    type?: string;
}

Hierarchy (view full)

Properties

action? busboyConfig? except? handler? @@ -10,4 +10,4 @@ openapi? path? type? -

Properties

Optional action

action?: string

Optional busboyConfig

busboyConfig?: BusboyConfig<unknown>

Optional except

except?: string[]

Optional handler

handler?: unknown

Optional method

method?: string

Optional only

only?: string[]

Optional openapi

openapi?: false | AliasRouteOpenApi

Optional path

path?: string

Optional type

type?: string

Settings

Member Visibility

Theme

On This Page

actionbusboyConfigexcepthandlermethodonlyopenapipathtype
\ No newline at end of file +

Properties

Optional action

action?: string

Optional busboyConfig

busboyConfig?: BusboyConfig<unknown>

Optional except

except?: string[]

Optional handler

handler?: unknown

Optional method

method?: string

Optional only

only?: string[]

Optional openapi

openapi?: false | AliasRouteOpenApi

Optional path

path?: string

Optional type

type?: string

Settings

Member Visibility

Theme

On This Page

actionbusboyConfigexcepthandlermethodonlyopenapipathtype
\ No newline at end of file diff --git a/interfaces/index.ApiRouteOpenApi.html b/interfaces/index.ApiRouteOpenApi.html index c652147..2ed9061 100644 --- a/interfaces/index.ApiRouteOpenApi.html +++ b/interfaces/index.ApiRouteOpenApi.html @@ -1,11 +1,11 @@ -ApiRouteOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ApiRouteOpenApi

interface ApiRouteOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    responses?: OptionalOrFalse<ResponsesObject>;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? +ApiRouteOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ApiRouteOpenApi

interface ApiRouteOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    responses?: OptionalOrFalse<ResponsesObject>;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? deprecated? responses? tags? -

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

-

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . +

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

+

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . Merged by levels

-

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

+

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

  • Use a tagObject to define it ( follow by his name to use it )
  • use null to remove all tags added previously (by merge from other levels)
    • @@ -19,4 +19,4 @@

    Example

    // remove pare

    Example

    // add tag with description, and use it on children
    {
     tags: [
         {
            name: "tags1";
            description: "this is the first example tag";
            externalDocs: "https://doc.example.com/tags/tags1";
         },
         'tags1'
     ]
    }
    -

Settings

Member Visibility

Theme

On This Page

componentsdeprecatedresponsestags
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

componentsdeprecatedresponsestags
\ No newline at end of file diff --git a/interfaces/index.ApiRouteSchema.html b/interfaces/index.ApiRouteSchema.html index 13006c9..fba1aa8 100644 --- a/interfaces/index.ApiRouteSchema.html +++ b/interfaces/index.ApiRouteSchema.html @@ -1,4 +1,4 @@ -ApiRouteSchema | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ApiRouteSchema

interface ApiRouteSchema {
    aliases?: {
        [k: string]: string | AliasFunction | (AliasFunction | string)[] | AliasRouteSchema;
    };
    authentication?: string | boolean;
    authorization?: string | boolean;
    autoAliases?: boolean;
    bodyParsers?: boolean | bodyParserOptions;
    busboyConfig?: BusboyConfig<onEventBusboyConfig<Alias>>;
    callOptions?: CallingOptions;
    camelCaseNames?: boolean;
    cors?: CorsOptions;
    debounceTime?: number;
    etag?: boolean | "weak" | "strong" | ETagFunction;
    logging?: boolean;
    mappingPolicy?: "all" | "restrict";
    mergeParams?: boolean;
    name?: string;
    onAfterCall?: onAfterCall;
    onBeforeCall?: onBeforeCall;
    onError?: ((req, res, error) => void);
    openapi?: false | ApiRouteOpenApi;
    path: string;
    rateLimit?: RateLimitSettings;
    use?: (routeMiddleware | routeMiddlewareError)[];
    whitelist?: (string | RegExp)[];
}

Hierarchy

  • CommonSettingSchema
    • ApiRouteSchema

Properties

aliases? +ApiRouteSchema | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ApiRouteSchema

interface ApiRouteSchema {
    aliases?: {
        [k: string]: string | AliasFunction | (AliasFunction | string)[] | AliasRouteSchema;
    };
    authentication?: string | boolean;
    authorization?: string | boolean;
    autoAliases?: boolean;
    bodyParsers?: boolean | bodyParserOptions;
    busboyConfig?: BusboyConfig<onEventBusboyConfig<Alias>>;
    callOptions?: CallingOptions;
    camelCaseNames?: boolean;
    cors?: CorsOptions;
    debounceTime?: number;
    etag?: boolean | "weak" | "strong" | ETagFunction;
    logging?: boolean;
    mappingPolicy?: "all" | "restrict";
    mergeParams?: boolean;
    name?: string;
    onAfterCall?: onAfterCall;
    onBeforeCall?: onBeforeCall;
    onError?: ((req, res, error) => void);
    openapi?: false | ApiRouteOpenApi;
    path: string;
    rateLimit?: RateLimitSettings;
    use?: (routeMiddleware | routeMiddlewareError)[];
    whitelist?: (string | RegExp)[];
}

Hierarchy

  • CommonSettingSchema
    • ApiRouteSchema

Properties

aliases? authentication? authorization? autoAliases? @@ -94,7 +94,7 @@

See

Optional onError

onError?: ((req, res, error) => void)

You can add route-level & global-level custom error handlers.
In handlers, you must call the res.end. Otherwise, the request is unhandled.

Type declaration

    • (req, res, error): void

    • Parameters

      • req: IncomingMessage
      • res: ServerResponse<IncomingMessage>
      • error: Error

      Returns void

See

https://moleculer.services/docs/0.14/moleculer-web.html#Error-handlers

-

Optional openapi

openapi?: false | ApiRouteOpenApi

path

path: string

Path prefix to this route

+

Optional openapi

openapi?: false | ApiRouteOpenApi

path

path: string

Path prefix to this route

Optional rateLimit

rateLimit?: RateLimitSettings

The Moleculer-Web has a built-in rate limiter with a memory store.

See

https://moleculer.services/docs/0.14/moleculer-web.html#Rate-limiter

Optional use

use?: (routeMiddleware | routeMiddlewareError)[]

It supports Connect-like middlewares in global-level, route-level & alias-level.
diff --git a/interfaces/index.ApiSettingsOpenApi.html b/interfaces/index.ApiSettingsOpenApi.html index cccb169..628e7a0 100644 --- a/interfaces/index.ApiSettingsOpenApi.html +++ b/interfaces/index.ApiSettingsOpenApi.html @@ -1,16 +1,16 @@ -ApiSettingsOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ApiSettingsOpenApi

interface ApiSettingsOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    responses?: OptionalOrFalse<ResponsesObject>;
    server?: ServerObject;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? +ApiSettingsOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ApiSettingsOpenApi

interface ApiSettingsOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    responses?: OptionalOrFalse<ResponsesObject>;
    server?: ServerObject;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? deprecated? responses? server? tags? -

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

-

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . +

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

+

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . Merged by levels

-

Optional server

server?: ServerObject

This configuration is under your responsibility. +

Optional server

server?: ServerObject

This configuration is under your responsibility. If assigned, ensure that the URL correctly points to your Moleculer-web API. This module will not modify the configuration (will not add the Moleculer-web root path). As such, it can accommodate any reverse proxy configuration.

-

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

+

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

  • Use a tagObject to define it ( follow by his name to use it )
  • use null to remove all tags added previously (by merge from other levels)
    • @@ -24,4 +24,4 @@

    Example

    // remove pare

    Example

    // add tag with description, and use it on children
    {
     tags: [
         {
            name: "tags1";
            description: "this is the first example tag";
            externalDocs: "https://doc.example.com/tags/tags1";
         },
         'tags1'
     ]
    }
    -

Settings

Member Visibility

Theme

On This Page

componentsdeprecatedresponsesservertags
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

componentsdeprecatedresponsesservertags
\ No newline at end of file diff --git a/interfaces/index.ApiSettingsSchemaOpenApi.html b/interfaces/index.ApiSettingsSchemaOpenApi.html index 1799b6d..32ad978 100644 --- a/interfaces/index.ApiSettingsSchemaOpenApi.html +++ b/interfaces/index.ApiSettingsSchemaOpenApi.html @@ -1,4 +1,4 @@ -ApiSettingsSchemaOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ApiSettingsSchemaOpenApi

interface ApiSettingsSchemaOpenApi {
    assets?: AssetsConfig;
    cors?: CorsOptions;
    etag?: boolean | "weak" | "strong" | ETagFunction;
    http2?: boolean;
    httpServerTimeout?: number;
    internalServiceSpecialChar?: string | RegExp;
    ip?: string;
    log4XXResponses?: boolean;
    logRequest?: null | LogLevels;
    logRequestParams?: null | LogLevels;
    logResponse?: null | LogLevels;
    logResponseData?: null | LogLevels;
    logRouteRegistration?: null | LogLevels;
    onError?: ((req, res, error) => void);
    openapi?: ApiSettingsOpenApi;
    optimizeOrder?: boolean;
    path?: string;
    port?: number;
    qsOptions?: IParseOptions;
    rateLimit?: RateLimitSettings;
    rootCallOptions?: CallingOptions;
    routes?: ApiRouteSchema[];
    server?: APISettingServer;
    use?: (routeMiddleware | routeMiddlewareError)[];
}

Hierarchy

  • ApiSettingsSchema
    • ApiSettingsSchemaOpenApi

Properties

assets? +ApiSettingsSchemaOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ApiSettingsSchemaOpenApi

interface ApiSettingsSchemaOpenApi {
    assets?: AssetsConfig;
    cors?: CorsOptions;
    etag?: boolean | "weak" | "strong" | ETagFunction;
    http2?: boolean;
    httpServerTimeout?: number;
    internalServiceSpecialChar?: string | RegExp;
    ip?: string;
    log4XXResponses?: boolean;
    logRequest?: null | LogLevels;
    logRequestParams?: null | LogLevels;
    logResponse?: null | LogLevels;
    logResponseData?: null | LogLevels;
    logRouteRegistration?: null | LogLevels;
    onError?: ((req, res, error) => void);
    openapi?: ApiSettingsOpenApi;
    optimizeOrder?: boolean;
    path?: string;
    port?: number;
    qsOptions?: IParseOptions;
    rateLimit?: RateLimitSettings;
    rootCallOptions?: CallingOptions;
    routes?: ApiRouteSchema[];
    server?: APISettingServer;
    use?: (routeMiddleware | routeMiddlewareError)[];
}

Hierarchy

  • ApiSettingsSchema
    • ApiSettingsSchemaOpenApi

Properties

assets? cors? etag? http2? @@ -70,7 +70,7 @@

Example

/

Optional onError

onError?: ((req, res, error) => void)

You can add route-level & global-level custom error handlers.
In handlers, you must call the res.end. Otherwise, the request is unhandled.

Type declaration

    • (req, res, error): void

    • Parameters

      • req: IncomingMessage
      • res: ServerResponse<IncomingMessage>
      • error: Error

      Returns void

See

https://moleculer.services/docs/0.14/moleculer-web.html#Error-handlers

-

Optional openapi

openapi?: ApiSettingsOpenApi

Optional optimizeOrder

optimizeOrder?: boolean

Optimize route order

+

Optional openapi

openapi?: ApiSettingsOpenApi

Optional optimizeOrder

optimizeOrder?: boolean

Optimize route order

Default

true

Optional path

path?: string

Global path prefix

@@ -84,7 +84,7 @@

Example

/

Optional rootCallOptions

rootCallOptions?: CallingOptions

CallOption for the root action api.rest

Default

null
-

Optional routes

routes?: ApiRouteSchema[]

Optional server

server?: APISettingServer

Used server instance. If null, it will create a new HTTP(s)(2) server
+

Optional routes

routes?: ApiRouteSchema[]

Optional server

server?: APISettingServer

Used server instance. If null, it will create a new HTTP(s)(2) server
If false, it will start without server in middleware mode

Default

true
diff --git a/interfaces/index.FVOARuleMetaKeys.html b/interfaces/index.FVOARuleMetaKeys.html index 69d5800..a53a4f9 100644 --- a/interfaces/index.FVOARuleMetaKeys.html +++ b/interfaces/index.FVOARuleMetaKeys.html @@ -1,9 +1,9 @@ FVOARuleMetaKeys | @spailybot/moleculer-auto-openapi - v1.3.1

Interface FVOARuleMetaKeys

These keys can be put to use within the rule set of the fastest validator schema, under the $$oa meta parameters.

Example

{
     $$strict: true,
     foo: {
         $$oa: {
             in: 'body';
             description: "rule description";
             summary: "deprecated rule summary";
             deprecated: true;
         },
         type: "string"
     },
     //the rest of your schema
 }
-
interface FVOARuleMetaKeys {
    deprecated?: boolean;
    description?: string;
    in?: "body" | "query";
    optional?: boolean;
    summary?: string;
}

Properties

deprecated? +
interface FVOARuleMetaKeys {
    deprecated?: boolean;
    description?: string;
    in?: "body" | "query";
    optional?: boolean;
    summary?: string;
}

Properties

deprecated? description? in? optional? summary? -

Properties

Optional deprecated

deprecated?: boolean

Optional description

description?: string

Optional in

in?: "body" | "query"

Optional optional

optional?: boolean

Optional summary

summary?: string

Settings

Member Visibility

Theme

On This Page

deprecateddescriptioninoptionalsummary
\ No newline at end of file +

Properties

Optional deprecated

deprecated?: boolean

Optional description

description?: string

Optional in

in?: "body" | "query"

Optional optional

optional?: boolean

Optional summary

summary?: string

Settings

Member Visibility

Theme

On This Page

deprecateddescriptioninoptionalsummary
\ No newline at end of file diff --git a/interfaces/index.FVOASchemaMetaKeys.html b/interfaces/index.FVOASchemaMetaKeys.html index 89b3a76..eb16c83 100644 --- a/interfaces/index.FVOASchemaMetaKeys.html +++ b/interfaces/index.FVOASchemaMetaKeys.html @@ -1,6 +1,6 @@ FVOASchemaMetaKeys | @spailybot/moleculer-auto-openapi - v1.3.1

Interface FVOASchemaMetaKeys

These keys can be utilized at the root level of the fastest validator schema within the $$oa meta parameters.

Example

{
    $$oa: {
        description: "my description",
        summary: "my summary"
    },
    $$strict: true,
    foo: "string",
    //the rest of your schema
}
-
interface FVOASchemaMetaKeys {
    description?: string;
    summary?: string;
}

Properties

description? +
interface FVOASchemaMetaKeys {
    description?: string;
    summary?: string;
}

Properties

description? summary? -

Properties

Optional description

description?: string

Optional summary

summary?: string

Settings

Member Visibility

Theme

On This Page

descriptionsummary
\ No newline at end of file +

Properties

Optional description

description?: string

Optional summary

summary?: string

Settings

Member Visibility

Theme

On This Page

descriptionsummary
\ No newline at end of file diff --git a/interfaces/index.MoleculerWebTypes.Alias.html b/interfaces/index.MoleculerWebTypes.Alias.html index 8f862e8..e93b314 100644 --- a/interfaces/index.MoleculerWebTypes.Alias.html +++ b/interfaces/index.MoleculerWebTypes.Alias.html @@ -1,4 +1,4 @@ -Alias | @spailybot/moleculer-auto-openapi - v1.3.1

Interface Alias

interface Alias {
    _generated: boolean;
    action: string;
    handler: null | Function[];
    method: string;
    path: string;
    route: MoleculerWebTypes.Route;
    service: Service<ServiceSettingSchema>;
    type: string;
}

Properties

_generated +Alias | @spailybot/moleculer-auto-openapi - v1.3.1

Interface Alias

interface Alias {
    _generated: boolean;
    action: string;
    handler: null | Function[];
    method: string;
    path: string;
    route: MoleculerWebTypes.Route;
    service: Service<ServiceSettingSchema>;
    type: string;
}

Properties

_generated action handler method @@ -6,4 +6,4 @@ route service type -

Properties

_generated

_generated: boolean

action

action: string

handler

handler: null | Function[]

method

method: string

path

path: string

route

route: MoleculerWebTypes.Route

service

service: Service<ServiceSettingSchema>

type

type: string

Settings

Member Visibility

Theme

On This Page

_generatedactionhandlermethodpathrouteservicetype
\ No newline at end of file +

Properties

_generated

_generated: boolean

action

action: string

handler

handler: null | Function[]

method

method: string

path

path: string

route

route: MoleculerWebTypes.Route

service

service: Service<ServiceSettingSchema>

type

type: string

Settings

Member Visibility

Theme

On This Page

_generatedactionhandlermethodpathrouteservicetype
\ No newline at end of file diff --git a/interfaces/index.MoleculerWebTypes.BusboyConfig.html b/interfaces/index.MoleculerWebTypes.BusboyConfig.html index 7e5354e..276e656 100644 --- a/interfaces/index.MoleculerWebTypes.BusboyConfig.html +++ b/interfaces/index.MoleculerWebTypes.BusboyConfig.html @@ -1,4 +1,4 @@ -BusboyConfig | @spailybot/moleculer-auto-openapi - v1.3.1

Interface BusboyConfig<T>

interface BusboyConfig<T> {
    defCharset?: string;
    fileHwm?: number;
    headers?: any;
    highWaterMark?: number;
    limits?: {
        fieldNameSize?: number;
        fieldSize?: number;
        fields?: number;
        fileSize?: number;
        files?: number;
        headerPairs?: number;
        parts?: number;
    };
    onFieldsLimit?: T;
    onFilesLimit?: T;
    onPartsLimit?: T;
    preservePath?: boolean;
}

Type Parameters

  • T

Properties

defCharset? +BusboyConfig | @spailybot/moleculer-auto-openapi - v1.3.1

Interface BusboyConfig<T>

interface BusboyConfig<T> {
    defCharset?: string;
    fileHwm?: number;
    headers?: any;
    highWaterMark?: number;
    limits?: {
        fieldNameSize?: number;
        fieldSize?: number;
        fields?: number;
        fileSize?: number;
        files?: number;
        headerPairs?: number;
        parts?: number;
    };
    onFieldsLimit?: T;
    onFilesLimit?: T;
    onPartsLimit?: T;
    preservePath?: boolean;
}

Type Parameters

  • T

Properties

defCharset? fileHwm? headers? highWaterMark? @@ -7,4 +7,4 @@ onFilesLimit? onPartsLimit? preservePath? -

Properties

Optional defCharset

defCharset?: string

Optional fileHwm

fileHwm?: number

Optional headers

headers?: any

Optional highWaterMark

highWaterMark?: number

Optional limits

limits?: {
    fieldNameSize?: number;
    fieldSize?: number;
    fields?: number;
    fileSize?: number;
    files?: number;
    headerPairs?: number;
    parts?: number;
}

Type declaration

  • Optional fieldNameSize?: number
  • Optional fieldSize?: number
  • Optional fields?: number
  • Optional fileSize?: number
  • Optional files?: number
  • Optional headerPairs?: number
  • Optional parts?: number

Optional onFieldsLimit

onFieldsLimit?: T

Optional onFilesLimit

onFilesLimit?: T

Optional onPartsLimit

onPartsLimit?: T

Optional preservePath

preservePath?: boolean

Settings

Member Visibility

Theme

On This Page

defCharsetfileHwmheadershighWaterMarklimitsonFieldsLimitonFilesLimitonPartsLimitpreservePath
\ No newline at end of file +

Properties

Optional defCharset

defCharset?: string

Optional fileHwm

fileHwm?: number

Optional headers

headers?: any

Optional highWaterMark

highWaterMark?: number

Optional limits

limits?: {
    fieldNameSize?: number;
    fieldSize?: number;
    fields?: number;
    fileSize?: number;
    files?: number;
    headerPairs?: number;
    parts?: number;
}

Type declaration

  • Optional fieldNameSize?: number
  • Optional fieldSize?: number
  • Optional fields?: number
  • Optional fileSize?: number
  • Optional files?: number
  • Optional headerPairs?: number
  • Optional parts?: number

Optional onFieldsLimit

onFieldsLimit?: T

Optional onFilesLimit

onFilesLimit?: T

Optional onPartsLimit

onPartsLimit?: T

Optional preservePath

preservePath?: boolean

Settings

Member Visibility

Theme

On This Page

defCharsetfileHwmheadershighWaterMarklimitsonFieldsLimitonFilesLimitonPartsLimitpreservePath
\ No newline at end of file diff --git a/interfaces/index.MoleculerWebTypes.CorsOptions.html b/interfaces/index.MoleculerWebTypes.CorsOptions.html index 6c381af..0b47125 100644 --- a/interfaces/index.MoleculerWebTypes.CorsOptions.html +++ b/interfaces/index.MoleculerWebTypes.CorsOptions.html @@ -1,4 +1,4 @@ -CorsOptions | @spailybot/moleculer-auto-openapi - v1.3.1

Interface CorsOptions

interface CorsOptions {
    allowedHeaders?: string | string[];
    credentials?: boolean;
    exposedHeaders?: string | string[];
    maxAge?: number;
    methods?: string | string[];
    optionsSuccessStatus?: number;
    origin?: string | boolean | RegExp | CustomOrigin | (string | RegExp)[];
    preflightContinue?: boolean;
}

Properties

allowedHeaders? +CorsOptions | @spailybot/moleculer-auto-openapi - v1.3.1

Interface CorsOptions

interface CorsOptions {
    allowedHeaders?: string | string[];
    credentials?: boolean;
    exposedHeaders?: string | string[];
    maxAge?: number;
    methods?: string | string[];
    optionsSuccessStatus?: number;
    origin?: string | boolean | RegExp | CustomOrigin | (string | RegExp)[];
    preflightContinue?: boolean;
}

Properties

allowedHeaders? credentials? exposedHeaders? maxAge? @@ -6,4 +6,4 @@ optionsSuccessStatus? origin? preflightContinue? -

Properties

Optional allowedHeaders

allowedHeaders?: string | string[]

Optional credentials

credentials?: boolean

Optional exposedHeaders

exposedHeaders?: string | string[]

Optional maxAge

maxAge?: number

Optional methods

methods?: string | string[]

Optional optionsSuccessStatus

optionsSuccessStatus?: number

Optional origin

origin?: string | boolean | RegExp | CustomOrigin | (string | RegExp)[]

Optional preflightContinue

preflightContinue?: boolean

Settings

Member Visibility

Theme

On This Page

allowedHeaderscredentialsexposedHeadersmaxAgemethodsoptionsSuccessStatusoriginpreflightContinue
\ No newline at end of file +

Properties

Optional allowedHeaders

allowedHeaders?: string | string[]

Optional credentials

credentials?: boolean

Optional exposedHeaders

exposedHeaders?: string | string[]

Optional maxAge

maxAge?: number

Optional methods

methods?: string | string[]

Optional optionsSuccessStatus

optionsSuccessStatus?: number

Optional origin

origin?: string | boolean | RegExp | CustomOrigin | (string | RegExp)[]

Optional preflightContinue

preflightContinue?: boolean

Settings

Member Visibility

Theme

On This Page

allowedHeaderscredentialsexposedHeadersmaxAgemethodsoptionsSuccessStatusoriginpreflightContinue
\ No newline at end of file diff --git a/interfaces/index.MoleculerWebTypes.NextFunction.html b/interfaces/index.MoleculerWebTypes.NextFunction.html index 75ab44a..1af2029 100644 --- a/interfaces/index.MoleculerWebTypes.NextFunction.html +++ b/interfaces/index.MoleculerWebTypes.NextFunction.html @@ -1,8 +1,8 @@ NextFunction | @spailybot/moleculer-auto-openapi - v1.3.1

Interface NextFunction

Expressjs next function
/@types/express-serve-static-core/index.d.ts:36

See

https://www.npmjs.com/package/@types/express-serve-static-core

-
interface NextFunction {
    (err?): void;
    (deferToNext): void;
    (deferToNext): void;
}
  • NextFunction(err?): void

  • Parameters

    • Optional err: any

    Returns void

  • NextFunction(deferToNext): void

  • "Break-out" of a router by calling {next('router')};

    +
interface NextFunction {
    (err?): void;
    (deferToNext): void;
    (deferToNext): void;
}

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/interfaces/index.MoleculerWebTypes.Route.html b/interfaces/index.MoleculerWebTypes.Route.html index 9853a0e..b531065 100644 --- a/interfaces/index.MoleculerWebTypes.Route.html +++ b/interfaces/index.MoleculerWebTypes.Route.html @@ -1,4 +1,4 @@ -Route | @spailybot/moleculer-auto-openapi - v1.3.1

Interface Route

interface Route {
    callOptions: any;
    cors: CorsOptions;
    etag: boolean | Function | "weak" | "strong";
    hasWhitelist: boolean;
    logging: boolean;
    mappingPolicy: string;
    middlewares: Function[];
    onAfterCall?: unknown;
    onBeforeCall?: unknown;
    opts: any;
    path: string;
    whitelist: string[];
}

Properties

callOptions +Route | @spailybot/moleculer-auto-openapi - v1.3.1

Interface Route

interface Route {
    callOptions: any;
    cors: CorsOptions;
    etag: boolean | Function | "weak" | "strong";
    hasWhitelist: boolean;
    logging: boolean;
    mappingPolicy: string;
    middlewares: Function[];
    onAfterCall?: unknown;
    onBeforeCall?: unknown;
    opts: any;
    path: string;
    whitelist: string[];
}

Properties

callOptions cors etag hasWhitelist @@ -10,4 +10,4 @@ opts path whitelist -

Properties

callOptions

callOptions: any

cors

cors: CorsOptions

etag

etag: boolean | Function | "weak" | "strong"

hasWhitelist

hasWhitelist: boolean

logging

logging: boolean

mappingPolicy

mappingPolicy: string

middlewares

middlewares: Function[]

Optional onAfterCall

onAfterCall?: unknown

Optional onBeforeCall

onBeforeCall?: unknown

opts

opts: any

path

path: string

whitelist

whitelist: string[]

Settings

Member Visibility

Theme

On This Page

callOptionscorsetaghasWhitelistloggingmappingPolicymiddlewaresonAfterCallonBeforeCalloptspathwhitelist
\ No newline at end of file +

Properties

callOptions

callOptions: any

cors

cors: CorsOptions

etag

etag: boolean | Function | "weak" | "strong"

hasWhitelist

hasWhitelist: boolean

logging

logging: boolean

mappingPolicy

mappingPolicy: string

middlewares

middlewares: Function[]

Optional onAfterCall

onAfterCall?: unknown

Optional onBeforeCall

onBeforeCall?: unknown

opts

opts: any

path

path: string

whitelist

whitelist: string[]

Settings

Member Visibility

Theme

On This Page

callOptionscorsetaghasWhitelistloggingmappingPolicymiddlewaresonAfterCallonBeforeCalloptspathwhitelist
\ No newline at end of file diff --git a/interfaces/index.MoleculerWebTypes.ServeStaticOptions.html b/interfaces/index.MoleculerWebTypes.ServeStaticOptions.html index ed010f8..a119180 100644 --- a/interfaces/index.MoleculerWebTypes.ServeStaticOptions.html +++ b/interfaces/index.MoleculerWebTypes.ServeStaticOptions.html @@ -1,4 +1,4 @@ -ServeStaticOptions | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ServeStaticOptions

interface ServeStaticOptions {
    cacheControl?: boolean;
    dotfiles?: string;
    etag?: boolean;
    extensions?: false | string[];
    fallthrough?: boolean;
    immutable?: boolean;
    index?: string | boolean | string[];
    lastModified?: boolean;
    maxAge?: string | number;
    redirect?: boolean;
    setHeaders?: ((res, path, stat) => any);
}

Properties

cacheControl? +ServeStaticOptions | @spailybot/moleculer-auto-openapi - v1.3.1

Interface ServeStaticOptions

interface ServeStaticOptions {
    cacheControl?: boolean;
    dotfiles?: string;
    etag?: boolean;
    extensions?: false | string[];
    fallthrough?: boolean;
    immutable?: boolean;
    index?: string | boolean | string[];
    lastModified?: boolean;
    maxAge?: string | number;
    redirect?: boolean;
    setHeaders?: ((res, path, stat) => any);
}

Properties

cacheControl? dotfiles? etag? extensions? @@ -9,29 +9,29 @@ maxAge? redirect? setHeaders? -

Properties

Optional cacheControl

cacheControl?: boolean

Optional dotfiles

dotfiles?: string

Set how "dotfiles" are treated when encountered. A dotfile is a file or directory that begins with a dot ("."). +

Properties

Optional cacheControl

cacheControl?: boolean

Optional dotfiles

dotfiles?: string

Set how "dotfiles" are treated when encountered. A dotfile is a file or directory that begins with a dot ("."). Note this check is done on the path itself without checking if the path actually exists on the disk. If root is specified, only the dotfiles above the root are checked (i.e. the root itself can be within a dotfile when when set to "deny"). The default value is 'ignore'. 'allow' No special treatment for dotfiles 'deny' Send a 403 for any request for a dotfile 'ignore' Pretend like the dotfile does not exist and call next()

-

Optional etag

etag?: boolean

Enable or disable etag generation, defaults to true.

-

Optional extensions

extensions?: false | string[]

Set file extension fallbacks. When set, if a file is not found, the given extensions will be added to the file name and search for. +

Optional etag

etag?: boolean

Enable or disable etag generation, defaults to true.

+

Optional extensions

extensions?: false | string[]

Set file extension fallbacks. When set, if a file is not found, the given extensions will be added to the file name and search for. The first that exists will be served. Example: ['html', 'htm']. The default value is false.

-

Optional fallthrough

fallthrough?: boolean

Let client errors fall-through as unhandled requests, otherwise forward a client error. +

Optional fallthrough

fallthrough?: boolean

Let client errors fall-through as unhandled requests, otherwise forward a client error. The default value is true.

-

Optional immutable

immutable?: boolean

Enable or disable the immutable directive in the Cache-Control response header. +

Optional immutable

immutable?: boolean

Enable or disable the immutable directive in the Cache-Control response header. If enabled, the maxAge option should also be specified to enable caching. The immutable directive will prevent supported clients from making conditional requests during the life of the maxAge option to check if the file has changed.

-

Optional index

index?: string | boolean | string[]

By default this module will send "index.html" files in response to a request on a directory. +

Optional index

index?: string | boolean | string[]

By default this module will send "index.html" files in response to a request on a directory. To disable this set false or to supply a new index pass a string or an array in preferred order.

-

Optional lastModified

lastModified?: boolean

Enable or disable Last-Modified header, defaults to true. Uses the file system's last modified value.

-

Optional maxAge

maxAge?: string | number

Provide a max-age in milliseconds for http caching, defaults to 0. This can also be a string accepted by the ms module.

-

Optional redirect

redirect?: boolean

Redirect to trailing "/" when the pathname is a dir. Defaults to true.

-

Optional setHeaders

setHeaders?: ((res, path, stat) => any)

Function to set custom headers on response. Alterations to the headers need to occur synchronously. +

Optional lastModified

lastModified?: boolean

Enable or disable Last-Modified header, defaults to true. Uses the file system's last modified value.

+

Optional maxAge

maxAge?: string | number

Provide a max-age in milliseconds for http caching, defaults to 0. This can also be a string accepted by the ms module.

+

Optional redirect

redirect?: boolean

Redirect to trailing "/" when the pathname is a dir. Defaults to true.

+

Optional setHeaders

setHeaders?: ((res, path, stat) => any)

Function to set custom headers on response. Alterations to the headers need to occur synchronously. The function is called as fn(res, path, stat), where the arguments are: res the response object path the file path that is being sent stat the stat object of the file that is being sent

-

Type declaration

    • (res, path, stat): any

    • Parameters

      • res: ServerResponse<IncomingMessage>
      • path: string
      • stat: any

      Returns any

Settings

Member Visibility

Theme

On This Page

cacheControldotfilesetagextensionsfallthroughimmutableindexlastModifiedmaxAgeredirectsetHeaders
\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

On This Page

cacheControldotfilesetagextensionsfallthroughimmutableindexlastModifiedmaxAgeredirectsetHeaders
\ No newline at end of file diff --git a/interfaces/index.OpenApiPaths.html b/interfaces/index.OpenApiPaths.html index 2a8e424..5cb75c8 100644 --- a/interfaces/index.OpenApiPaths.html +++ b/interfaces/index.OpenApiPaths.html @@ -1,4 +1,4 @@ -OpenApiPaths | @spailybot/moleculer-auto-openapi - v1.3.1

Interface OpenApiPaths

interface OpenApiPaths {
    assetsPath: string;
    oauth2RedirectPath: string;
    schemaPath: string;
    uiPath: string;
}

Properties

assetsPath +OpenApiPaths | @spailybot/moleculer-auto-openapi - v1.3.1

Interface OpenApiPaths

interface OpenApiPaths {
    assetsPath: string;
    oauth2RedirectPath: string;
    schemaPath: string;
    uiPath: string;
}

Properties

assetsPath oauth2RedirectPath schemaPath uiPath @@ -6,7 +6,7 @@

You can use unpkg CDN by setting //unpkg.com/swagger-ui-dist[@] :

Default

//unpkg.com/swagger-ui-dist (if openApiPaths is an object)
-

oauth2RedirectPath

oauth2RedirectPath: string

path to oauth2Redirect or to a custom oauth2Redirect

-

schemaPath

schemaPath: string

path to openapi.json / to the openapi generation action

-

uiPath

uiPath: string

path to serve the swagger UI

-

Settings

Member Visibility

Theme

On This Page

assetsPathoauth2RedirectPathschemaPathuiPath
\ No newline at end of file +

oauth2RedirectPath

oauth2RedirectPath: string

path to oauth2Redirect or to a custom oauth2Redirect

+

schemaPath

schemaPath: string

path to openapi.json / to the openapi generation action

+

uiPath

uiPath: string

path to serve the swagger UI

+

Settings

Member Visibility

Theme

On This Page

assetsPathoauth2RedirectPathschemaPathuiPath
\ No newline at end of file diff --git a/interfaces/index.SwaggerUiOptions.html b/interfaces/index.SwaggerUiOptions.html index 6a48ca5..5e4dfc2 100644 --- a/interfaces/index.SwaggerUiOptions.html +++ b/interfaces/index.SwaggerUiOptions.html @@ -1,4 +1,4 @@ -SwaggerUiOptions | @spailybot/moleculer-auto-openapi - v1.3.1

Interface SwaggerUiOptions

interface SwaggerUiOptions {
    deepLinking?: boolean;
    defaultModelExpandDepth?: number;
    defaultModelRendering?: "example" | "model";
    defaultModelsExpandDepth?: number;
    displayOperationId?: boolean;
    displayRequestDuration?: boolean;
    docExpansion?: "list" | "full" | "none";
    filter?: string | boolean;
    layout?: string;
    maxDisplayedTags?: number;
    primaryName?: string;
    queryConfigEnabled?: boolean;
    requestSnippets?: {
        generators?: {
            curl_bash?: {
                syntax: string;
                title: string;
            };
            curl_cmd?: {
                syntax: string;
                title: string;
            };
            curl_powershell?: {
                syntax: string;
                title: string;
            };
            defaultExpanded?: boolean;
            languages?: null | ["curl_bash"];
        };
        persistAuthorization?: boolean;
        showMutatedRequest?: boolean;
        supportedSubmitMethods?: string[];
        validatorUrl?: null | string;
        withCredentials?: boolean;
    };
    requestSnippetsEnabled?: boolean;
    showCommonExtensions?: boolean;
    showExtensions?: boolean;
    syntaxHighlight?: false | {
        activate?: boolean;
        theme?: "agate" | "arta" | "monokai" | "nord" | "obsidian" | "tomorrow-night" | "idea";
    };
    tryItOutEnabled?: boolean;
}

Properties

deepLinking? +SwaggerUiOptions | @spailybot/moleculer-auto-openapi - v1.3.1

Interface SwaggerUiOptions

interface SwaggerUiOptions {
    deepLinking?: boolean;
    defaultModelExpandDepth?: number;
    defaultModelRendering?: "example" | "model";
    defaultModelsExpandDepth?: number;
    displayOperationId?: boolean;
    displayRequestDuration?: boolean;
    docExpansion?: "list" | "full" | "none";
    filter?: string | boolean;
    layout?: string;
    maxDisplayedTags?: number;
    primaryName?: string;
    queryConfigEnabled?: boolean;
    requestSnippets?: {
        generators?: {
            curl_bash?: {
                syntax: string;
                title: string;
            };
            curl_cmd?: {
                syntax: string;
                title: string;
            };
            curl_powershell?: {
                syntax: string;
                title: string;
            };
            defaultExpanded?: boolean;
            languages?: null | ["curl_bash"];
        };
        persistAuthorization?: boolean;
        showMutatedRequest?: boolean;
        supportedSubmitMethods?: string[];
        validatorUrl?: null | string;
        withCredentials?: boolean;
    };
    requestSnippetsEnabled?: boolean;
    showCommonExtensions?: boolean;
    showExtensions?: boolean;
    syntaxHighlight?: false | {
        activate?: boolean;
        theme?: "agate" | "arta" | "monokai" | "nord" | "obsidian" | "tomorrow-night" | "idea";
    };
    tryItOutEnabled?: boolean;
}

Properties

deepLinking? defaultModelExpandDepth? defaultModelRendering? defaultModelsExpandDepth? @@ -19,42 +19,42 @@

Properties

Optional deepLinking

deepLinking?: boolean

If set to true, enables deep linking for tags and operations. See the Deep Linking documentation for more information.

Default

true
-

Optional defaultModelExpandDepth

defaultModelExpandDepth?: number

The default expansion depth for the model on the model-example section.

+

Optional defaultModelExpandDepth

defaultModelExpandDepth?: number

The default expansion depth for the model on the model-example section.

Default

1
-

Optional defaultModelRendering

defaultModelRendering?: "example" | "model"

Controls how the model is shown when the API is first rendered. +

Optional defaultModelRendering

defaultModelRendering?: "example" | "model"

Controls how the model is shown when the API is first rendered. The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.

Default

example
-

Optional defaultModelsExpandDepth

defaultModelsExpandDepth?: number

The default expansion depth for models (set to -1 completely hide the models).

+

Optional defaultModelsExpandDepth

defaultModelsExpandDepth?: number

The default expansion depth for models (set to -1 completely hide the models).

Default

1
-

Optional displayOperationId

displayOperationId?: boolean

Controls the display of operationId in operations list.

+

Optional displayOperationId

displayOperationId?: boolean

Controls the display of operationId in operations list.

Default

false.
-

Optional displayRequestDuration

displayRequestDuration?: boolean

Controls the display of the request duration (in milliseconds) for "Try it out" requests.

+

Optional displayRequestDuration

displayRequestDuration?: boolean

Controls the display of the request duration (in milliseconds) for "Try it out" requests.

Default

false
-

Optional docExpansion

docExpansion?: "list" | "full" | "none"

Controls the default expansion setting for the operations and tags. It +

Optional docExpansion

docExpansion?: "list" | "full" | "none"

Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).

Default

list
-

Optional filter

filter?: string | boolean

If set, enables filtering. The top bar will show an edit box that you +

Optional filter

filter?: string | boolean

If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case-sensitive matching the filter expression anywhere inside the tag.

-

Optional layout

layout?: string

The name of a component available via the plugin system to use as the top-level layout for Swagger UI.

+

Optional layout

layout?: string

The name of a component available via the plugin system to use as the top-level layout for Swagger UI.

Default

StandaloneLayout
-

Optional maxDisplayedTags

maxDisplayedTags?: number

If set, limits the number of tagged operations displayed to at most this many. +

Optional maxDisplayedTags

maxDisplayedTags?: number

If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations.

-

Optional primaryName

primaryName?: string

If the value matches the name of a spec provided in urls, that spec will be displayed when Swagger UI loads, instead of defaulting to the first spec in urls.

-

Optional queryConfigEnabled

queryConfigEnabled?: boolean

Enables overriding configuration parameters via URL search params.

+

Optional primaryName

primaryName?: string

If the value matches the name of a spec provided in urls, that spec will be displayed when Swagger UI loads, instead of defaulting to the first spec in urls.

+

Optional queryConfigEnabled

queryConfigEnabled?: boolean

Enables overriding configuration parameters via URL search params.

Default

false
-

Optional requestSnippets

requestSnippets?: {
    generators?: {
        curl_bash?: {
            syntax: string;
            title: string;
        };
        curl_cmd?: {
            syntax: string;
            title: string;
        };
        curl_powershell?: {
            syntax: string;
            title: string;
        };
        defaultExpanded?: boolean;
        languages?: null | ["curl_bash"];
    };
    persistAuthorization?: boolean;
    showMutatedRequest?: boolean;
    supportedSubmitMethods?: string[];
    validatorUrl?: null | string;
    withCredentials?: boolean;
}

This is the default configuration section for the requestSnippets plugin.

+

Optional requestSnippets

requestSnippets?: {
    generators?: {
        curl_bash?: {
            syntax: string;
            title: string;
        };
        curl_cmd?: {
            syntax: string;
            title: string;
        };
        curl_powershell?: {
            syntax: string;
            title: string;
        };
        defaultExpanded?: boolean;
        languages?: null | ["curl_bash"];
    };
    persistAuthorization?: boolean;
    showMutatedRequest?: boolean;
    supportedSubmitMethods?: string[];
    validatorUrl?: null | string;
    withCredentials?: boolean;
}

This is the default configuration section for the requestSnippets plugin.

Type declaration

  • Optional generators?: {
        curl_bash?: {
            syntax: string;
            title: string;
        };
        curl_cmd?: {
            syntax: string;
            title: string;
        };
        curl_powershell?: {
            syntax: string;
            title: string;
        };
        defaultExpanded?: boolean;
        languages?: null | ["curl_bash"];
    }

    Generators for different shell syntax.

    • Optional curl_bash?: {
          syntax: string;
          title: string;
      }

      cURL command for Bash shell

      • syntax: string
      • title: string
    • Optional curl_cmd?: {
          syntax: string;
          title: string;
      }

      cURL command for CMD shell

      @@ -74,24 +74,24 @@

      Default

      https://validator.swagger.io/validator
    • Optional withCredentials?: boolean

      If set to true, enables passing credentials, as defined in the Fetch standard, in CORS requests that are sent by the browser. Note that Swagger UI cannot currently set cookies cross-domain (see swagger-js#1163) - as a result, you will have to rely on browser-supplied cookies (which this setting enables sending) that Swagger UI cannot control.

      -

Optional requestSnippetsEnabled

requestSnippetsEnabled?: boolean

Enables the request snippet section. When disabled, the legacy curl snippet will be used.

+

Optional requestSnippetsEnabled

requestSnippetsEnabled?: boolean

Enables the request snippet section. When disabled, the legacy curl snippet will be used.

Default

false
-

Optional showCommonExtensions

showCommonExtensions?: boolean

Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields +

Optional showCommonExtensions

showCommonExtensions?: boolean

Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters.

Default

false
-

Optional showExtensions

showExtensions?: boolean

Controls the display of vendor extensions (x-) fields and values for Operations, Parameters, Responses, +

Optional showExtensions

showExtensions?: boolean

Controls the display of vendor extensions (x-) fields and values for Operations, Parameters, Responses, and Schema.

Default

true
-

Optional syntaxHighlight

syntaxHighlight?: false | {
    activate?: boolean;
    theme?: "agate" | "arta" | "monokai" | "nord" | "obsidian" | "tomorrow-night" | "idea";
}

Set to false to deactivate syntax highlighting of payloads and cURL command, +

Optional syntaxHighlight

syntaxHighlight?: false | {
    activate?: boolean;
    theme?: "agate" | "arta" | "monokai" | "nord" | "obsidian" | "tomorrow-night" | "idea";
}

Set to false to deactivate syntax highlighting of payloads and cURL command, can be otherwise an object with the activate and theme properties.

Type declaration

  • Optional activate?: boolean

    Boolean=true. Whether syntax highlighting should be activated or not.

  • Optional theme?: "agate" | "arta" | "monokai" | "nord" | "obsidian" | "tomorrow-night" | "idea"

    Highlight.js syntax coloring theme to use. (Only these 7 styles are available.)

Default

false
-

Optional tryItOutEnabled

tryItOutEnabled?: boolean

Controls whether the "Try it out" section should be enabled by default.

+

Optional tryItOutEnabled

tryItOutEnabled?: boolean

Controls whether the "Try it out" section should be enabled by default.

Default

false
-

Settings

Member Visibility

Theme

On This Page

deepLinkingdefaultModelExpandDepthdefaultModelRenderingdefaultModelsExpandDepthdisplayOperationIddisplayRequestDurationdocExpansionfilterlayoutmaxDisplayedTagsprimaryNamequeryConfigEnabledrequestSnippetsrequestSnippetsEnabledshowCommonExtensionsshowExtensionssyntaxHighlighttryItOutEnabled
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

deepLinkingdefaultModelExpandDepthdefaultModelRenderingdefaultModelsExpandDepthdisplayOperationIddisplayRequestDurationdocExpansionfilterlayoutmaxDisplayedTagsprimaryNamequeryConfigEnabledrequestSnippetsrequestSnippetsEnabledshowCommonExtensionsshowExtensionssyntaxHighlighttryItOutEnabled
\ No newline at end of file diff --git a/interfaces/index.TemplateVariables.html b/interfaces/index.TemplateVariables.html index c39306c..49e8c48 100644 --- a/interfaces/index.TemplateVariables.html +++ b/interfaces/index.TemplateVariables.html @@ -1,4 +1,4 @@ -TemplateVariables | @spailybot/moleculer-auto-openapi - v1.3.1

Interface TemplateVariables

interface TemplateVariables {
    action: string;
    autoAlias: string;
    summary: string;
}

Properties

action +TemplateVariables | @spailybot/moleculer-auto-openapi - v1.3.1

Interface TemplateVariables

interface TemplateVariables {
    action: string;
    autoAlias: string;
    summary: string;
}

Properties

action autoAlias summary -

Properties

action

action: string

autoAlias

autoAlias: string

summary

summary: string

Settings

Member Visibility

Theme

On This Page

actionautoAliassummary
\ No newline at end of file +

Properties

action

action: string

autoAlias

autoAlias: string

summary

summary: string

Settings

Member Visibility

Theme

On This Page

actionautoAliassummary
\ No newline at end of file diff --git a/interfaces/index.commonOpenApi.html b/interfaces/index.commonOpenApi.html index 67e5046..45fe786 100644 --- a/interfaces/index.commonOpenApi.html +++ b/interfaces/index.commonOpenApi.html @@ -1,11 +1,11 @@ -commonOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface commonOpenApi

interface commonOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    responses?: OptionalOrFalse<ResponsesObject>;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? +commonOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

Interface commonOpenApi

interface commonOpenApi {
    components?: SubOptionalOrFalse<ComponentsObject>;
    deprecated?: boolean;
    responses?: OptionalOrFalse<ResponsesObject>;
    tags?: openApiTag[];
}

Hierarchy (view full)

Properties

components? deprecated? responses? tags? -

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

-

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . +

Properties

Optional components

components?: SubOptionalOrFalse<ComponentsObject>

Optional deprecated

deprecated?: boolean

set this endpoint as deprecated

+

Optional responses

responses?: OptionalOrFalse<ResponsesObject>

specify all responses of the operation . Merged by levels

-

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

+

Optional tags

tags?: openApiTag[]

Allow to define tags of the https://spec.openapis.org/oas/v3.1.0#operation-object|Operation

  • Use a tagObject to define it ( follow by his name to use it )
  • use null to remove all tags added previously (by merge from other levels)
    • @@ -19,4 +19,4 @@

    Example

    // remove pare

    Example

    // add tag with description, and use it on children
    {
     tags: [
         {
            name: "tags1";
            description: "this is the first example tag";
            externalDocs: "https://doc.example.com/tags/tags1";
         },
         'tags1'
     ]
    }
    -

Settings

Member Visibility

Theme

On This Page

componentsdeprecatedresponsestags
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

componentsdeprecatedresponsestags
\ No newline at end of file diff --git a/modules/index.MoleculerWebTypes.html b/modules/index.MoleculerWebTypes.html index b9fea5e..ded37eb 100644 --- a/modules/index.MoleculerWebTypes.html +++ b/modules/index.MoleculerWebTypes.html @@ -1,4 +1,4 @@ -MoleculerWebTypes | @spailybot/moleculer-auto-openapi - v1.3.1

Namespace MoleculerWebTypes

Index

Interfaces

Alias +MoleculerWebTypes | @spailybot/moleculer-auto-openapi - v1.3.1

Namespace MoleculerWebTypes

Index

Interfaces

Alias BusboyConfig CorsOptions NextFunction diff --git a/modules/index.html b/modules/index.html index 3f20c66..0db4f7e 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | @spailybot/moleculer-auto-openapi - v1.3.1

Module index

References

default +index | @spailybot/moleculer-auto-openapi - v1.3.1

Module index

References

default

Namespaces

MoleculerWebTypes

Enumerations

ECacheMode HTTP_METHODS diff --git a/modules/types_internal.html b/modules/types_internal.html index 76261a5..dbf4a50 100644 --- a/modules/types_internal.html +++ b/modules/types_internal.html @@ -1,4 +1,4 @@ -types/internal | @spailybot/moleculer-auto-openapi - v1.3.1

Module types/internal

Index

Type Aliases

EOAExtensionsValues +types/internal | @spailybot/moleculer-auto-openapi - v1.3.1

Module types/internal

Index

Type Aliases

EOAExtensionsValues EOAOperationsExtensionTypes EOASchemaExtensionTypes EOASchemaExtensionsValueTypes diff --git a/types/index.FastestValidatorType.html b/types/index.FastestValidatorType.html index 8cedad7..9ed209c 100644 --- a/types/index.FastestValidatorType.html +++ b/types/index.FastestValidatorType.html @@ -1,2 +1,2 @@ FastestValidatorType | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias FastestValidatorType

FastestValidatorType: FastestValidatorDefault.default

a way to get the type of the fastestValidator object

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.Mapper.html b/types/index.Mapper.html index 646ee25..0f738a6 100644 --- a/types/index.Mapper.html +++ b/types/index.Mapper.html @@ -1 +1 @@ -Mapper | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias Mapper<Rule>

Mapper<Rule>: ((rule, schema?) => OpenAPIV3_1.SchemaObject | undefined)

Type Parameters

  • Rule extends RuleCustom

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +Mapper | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias Mapper<Rule>

Mapper<Rule>: ((rule, schema?) => OpenAPIV3_1.SchemaObject | undefined)

Type Parameters

  • Rule extends RuleCustom

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.Mappers.html b/types/index.Mappers.html index 63e3e1c..c25f191 100644 --- a/types/index.Mappers.html +++ b/types/index.Mappers.html @@ -1 +1 @@ -Mappers | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias Mappers

Mappers: {
    [K in keyof ValidationRuleMapping]: Mapper<ValidationRuleMapping[K]>
}

Settings

Member Visibility

Theme

\ No newline at end of file +Mappers | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias Mappers

Mappers: {
    [K in keyof ValidationRuleMapping]: Mapper<ValidationRuleMapping[K]>
}

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.AliasFunction.html b/types/index.MoleculerWebTypes.AliasFunction.html index 309937a..2c5cf8c 100644 --- a/types/index.MoleculerWebTypes.AliasFunction.html +++ b/types/index.MoleculerWebTypes.AliasFunction.html @@ -1 +1 @@ -AliasFunction | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias AliasFunction

AliasFunction: unknown

Settings

Member Visibility

Theme

\ No newline at end of file +AliasFunction | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias AliasFunction

AliasFunction: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.AliasRouteSchema.html b/types/index.MoleculerWebTypes.AliasRouteSchema.html index 4ee40a7..c5e7842 100644 --- a/types/index.MoleculerWebTypes.AliasRouteSchema.html +++ b/types/index.MoleculerWebTypes.AliasRouteSchema.html @@ -1 +1 @@ -AliasRouteSchema | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias AliasRouteSchema

AliasRouteSchema: {
    action?: string;
    busboyConfig?: BusboyConfig<onEventBusboyConfig<MoleculerWebTypes.Alias>>;
    except?: string[];
    handler?: AliasFunction;
    method?: "GET" | "POST" | "PUT" | "DELETE" | "*" | "HEAD" | "OPTIONS" | "PATCH" | string;
    only?: string[];
    path?: string;
    type?: "call" | "multipart" | "stream" | string;
    [k: string]: any;
}

Type declaration

  • [k: string]: any
  • Optional action?: string
  • Optional busboyConfig?: BusboyConfig<onEventBusboyConfig<MoleculerWebTypes.Alias>>
  • Optional except?: string[]
  • Optional handler?: AliasFunction
  • Optional method?: "GET" | "POST" | "PUT" | "DELETE" | "*" | "HEAD" | "OPTIONS" | "PATCH" | string
  • Optional only?: string[]
  • Optional path?: string
  • Optional type?: "call" | "multipart" | "stream" | string

Settings

Member Visibility

Theme

\ No newline at end of file +AliasRouteSchema | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias AliasRouteSchema

AliasRouteSchema: {
    action?: string;
    busboyConfig?: BusboyConfig<onEventBusboyConfig<MoleculerWebTypes.Alias>>;
    except?: string[];
    handler?: AliasFunction;
    method?: "GET" | "POST" | "PUT" | "DELETE" | "*" | "HEAD" | "OPTIONS" | "PATCH" | string;
    only?: string[];
    path?: string;
    type?: "call" | "multipart" | "stream" | string;
    [k: string]: any;
}

Type declaration

  • [k: string]: any
  • Optional action?: string
  • Optional busboyConfig?: BusboyConfig<onEventBusboyConfig<MoleculerWebTypes.Alias>>
  • Optional except?: string[]
  • Optional handler?: AliasFunction
  • Optional method?: "GET" | "POST" | "PUT" | "DELETE" | "*" | "HEAD" | "OPTIONS" | "PATCH" | string
  • Optional only?: string[]
  • Optional path?: string
  • Optional type?: "call" | "multipart" | "stream" | string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.ApiRouteSchema.html b/types/index.MoleculerWebTypes.ApiRouteSchema.html index 2f2526c..b4439c5 100644 --- a/types/index.MoleculerWebTypes.ApiRouteSchema.html +++ b/types/index.MoleculerWebTypes.ApiRouteSchema.html @@ -67,4 +67,4 @@ "users.list": Access call only the 'users.list' action
/^math.\w+$/: Access any actions in 'math' service

See

https://moleculer.services/docs/0.14/moleculer-web.html#Whitelist

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.ApiSchemaAlias.html b/types/index.MoleculerWebTypes.ApiSchemaAlias.html index 9d7c50f..8b8f76b 100644 --- a/types/index.MoleculerWebTypes.ApiSchemaAlias.html +++ b/types/index.MoleculerWebTypes.ApiSchemaAlias.html @@ -1 +1 @@ -ApiSchemaAlias | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias ApiSchemaAlias

ApiSchemaAlias: string | AliasFunction | (AliasFunction | string)[] | AliasRouteSchema

Settings

Member Visibility

Theme

\ No newline at end of file +ApiSchemaAlias | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias ApiSchemaAlias

ApiSchemaAlias: string | AliasFunction | (AliasFunction | string)[] | AliasRouteSchema

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.ApiSettingsSchema.html b/types/index.MoleculerWebTypes.ApiSettingsSchema.html index 6cd245b..207d23d 100644 --- a/types/index.MoleculerWebTypes.ApiSettingsSchema.html +++ b/types/index.MoleculerWebTypes.ApiSettingsSchema.html @@ -55,4 +55,4 @@

Example

/

Default

true
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.AssetsConfig.html b/types/index.MoleculerWebTypes.AssetsConfig.html index 080a77f..e4eb8f9 100644 --- a/types/index.MoleculerWebTypes.AssetsConfig.html +++ b/types/index.MoleculerWebTypes.AssetsConfig.html @@ -1,3 +1,3 @@ AssetsConfig | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias AssetsConfig

AssetsConfig: {
    folder: string;
    options?: ServeStaticOptions;
}

Type declaration

  • folder: string

    Root folder of assets

  • Optional options?: ServeStaticOptions

    Further options to server-static module

    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.CommonSettingSchema.html b/types/index.MoleculerWebTypes.CommonSettingSchema.html index 70e362f..55f137d 100644 --- a/types/index.MoleculerWebTypes.CommonSettingSchema.html +++ b/types/index.MoleculerWebTypes.CommonSettingSchema.html @@ -16,4 +16,4 @@

See

express middleware

See

https://moleculer.services/docs/0.14/moleculer-web.html#Middlewares

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.CustomOrigin.html b/types/index.MoleculerWebTypes.CustomOrigin.html index 7891b6b..b9502ea 100644 --- a/types/index.MoleculerWebTypes.CustomOrigin.html +++ b/types/index.MoleculerWebTypes.CustomOrigin.html @@ -1 +1 @@ -CustomOrigin | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias CustomOrigin

CustomOrigin: ((origin) => boolean)

Type declaration

    • (origin): boolean

    • Parameters

      • origin: string

      Returns boolean

Settings

Member Visibility

Theme

\ No newline at end of file +CustomOrigin | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias CustomOrigin

CustomOrigin: ((origin) => boolean)

Type declaration

    • (origin): boolean

    • Parameters

      • origin: string

      Returns boolean

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.ETagFunction.html b/types/index.MoleculerWebTypes.ETagFunction.html index 6f00b5d..78c61f6 100644 --- a/types/index.MoleculerWebTypes.ETagFunction.html +++ b/types/index.MoleculerWebTypes.ETagFunction.html @@ -1 +1 @@ -ETagFunction | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias ETagFunction

ETagFunction: unknown

Settings

Member Visibility

Theme

\ No newline at end of file +ETagFunction | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias ETagFunction

ETagFunction: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.MOLECULER_WEB_LIST_ALIASES_INPUT.html b/types/index.MoleculerWebTypes.MOLECULER_WEB_LIST_ALIASES_INPUT.html index b6c1721..8e7ab7d 100644 --- a/types/index.MoleculerWebTypes.MOLECULER_WEB_LIST_ALIASES_INPUT.html +++ b/types/index.MoleculerWebTypes.MOLECULER_WEB_LIST_ALIASES_INPUT.html @@ -1 +1 @@ -MOLECULER_WEB_LIST_ALIASES_INPUT | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias MOLECULER_WEB_LIST_ALIASES_INPUT

MOLECULER_WEB_LIST_ALIASES_INPUT: {
    grouping?: boolean;
    withActionSchema?: boolean;
}

Type declaration

  • Optional grouping?: boolean
  • Optional withActionSchema?: boolean

Settings

Member Visibility

Theme

\ No newline at end of file +MOLECULER_WEB_LIST_ALIASES_INPUT | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias MOLECULER_WEB_LIST_ALIASES_INPUT

MOLECULER_WEB_LIST_ALIASES_INPUT: {
    grouping?: boolean;
    withActionSchema?: boolean;
}

Type declaration

  • Optional grouping?: boolean
  • Optional withActionSchema?: boolean

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.MOLECULER_WEB_LIST_ALIASES_OUTPUT.html b/types/index.MoleculerWebTypes.MOLECULER_WEB_LIST_ALIASES_OUTPUT.html index 37c6262..a0cb62f 100644 --- a/types/index.MoleculerWebTypes.MOLECULER_WEB_LIST_ALIASES_OUTPUT.html +++ b/types/index.MoleculerWebTypes.MOLECULER_WEB_LIST_ALIASES_OUTPUT.html @@ -1 +1 @@ -MOLECULER_WEB_LIST_ALIASES_OUTPUT | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias MOLECULER_WEB_LIST_ALIASES_OUTPUT

MOLECULER_WEB_LIST_ALIASES_OUTPUT: routeAlias[]

Settings

Member Visibility

Theme

\ No newline at end of file +MOLECULER_WEB_LIST_ALIASES_OUTPUT | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias MOLECULER_WEB_LIST_ALIASES_OUTPUT

MOLECULER_WEB_LIST_ALIASES_OUTPUT: routeAlias[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.RestServiceSettings.html b/types/index.MoleculerWebTypes.RestServiceSettings.html index 1c11303..1a86233 100644 --- a/types/index.MoleculerWebTypes.RestServiceSettings.html +++ b/types/index.MoleculerWebTypes.RestServiceSettings.html @@ -1 +1 @@ -RestServiceSettings | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias RestServiceSettings

RestServiceSettings: {
    rest?: string | string[];
}

Type declaration

  • Optional rest?: string | string[]

Settings

Member Visibility

Theme

\ No newline at end of file +RestServiceSettings | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias RestServiceSettings

RestServiceSettings: {
    rest?: string | string[];
}

Type declaration

  • Optional rest?: string | string[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.bodyParserOptions.html b/types/index.MoleculerWebTypes.bodyParserOptions.html index abbe078..e5220d1 100644 --- a/types/index.MoleculerWebTypes.bodyParserOptions.html +++ b/types/index.MoleculerWebTypes.bodyParserOptions.html @@ -1,2 +1,2 @@ bodyParserOptions | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias bodyParserOptions

bodyParserOptions: {
    json?: BodyParser.OptionsJson | boolean;
    raw?: BodyParser.Options | boolean;
    text?: BodyParser.OptionsText | boolean;
    urlencoded?: BodyParser.OptionsUrlencoded | boolean;
}

COPY of some moleculer-web interface that can be needed, but not exported

-

Type declaration

  • Optional json?: BodyParser.OptionsJson | boolean
  • Optional raw?: BodyParser.Options | boolean
  • Optional text?: BodyParser.OptionsText | boolean
  • Optional urlencoded?: BodyParser.OptionsUrlencoded | boolean

Settings

Member Visibility

Theme

\ No newline at end of file +

Type declaration

  • Optional json?: BodyParser.OptionsJson | boolean
  • Optional raw?: BodyParser.Options | boolean
  • Optional text?: BodyParser.OptionsText | boolean
  • Optional urlencoded?: BodyParser.OptionsUrlencoded | boolean

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.onAfterCall.html b/types/index.MoleculerWebTypes.onAfterCall.html index 2139ca2..2a1d22c 100644 --- a/types/index.MoleculerWebTypes.onAfterCall.html +++ b/types/index.MoleculerWebTypes.onAfterCall.html @@ -1 +1 @@ -onAfterCall | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias onAfterCall

onAfterCall: unknown

Settings

Member Visibility

Theme

\ No newline at end of file +onAfterCall | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias onAfterCall

onAfterCall: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.onBeforeCall.html b/types/index.MoleculerWebTypes.onBeforeCall.html index 0b9b51b..daefccc 100644 --- a/types/index.MoleculerWebTypes.onBeforeCall.html +++ b/types/index.MoleculerWebTypes.onBeforeCall.html @@ -1 +1 @@ -onBeforeCall | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias onBeforeCall

onBeforeCall: unknown

Settings

Member Visibility

Theme

\ No newline at end of file +onBeforeCall | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias onBeforeCall

onBeforeCall: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.onEventBusboyConfig.html b/types/index.MoleculerWebTypes.onEventBusboyConfig.html index e7adb6c..9134ec0 100644 --- a/types/index.MoleculerWebTypes.onEventBusboyConfig.html +++ b/types/index.MoleculerWebTypes.onEventBusboyConfig.html @@ -1 +1 @@ -onEventBusboyConfig | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias onEventBusboyConfig<T>

onEventBusboyConfig<T>: unknown

Type Parameters

  • T

Settings

Member Visibility

Theme

\ No newline at end of file +onEventBusboyConfig | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias onEventBusboyConfig<T>

onEventBusboyConfig<T>: unknown

Type Parameters

  • T

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.routeAlias.html b/types/index.MoleculerWebTypes.routeAlias.html index b974ca7..bfaf08e 100644 --- a/types/index.MoleculerWebTypes.routeAlias.html +++ b/types/index.MoleculerWebTypes.routeAlias.html @@ -1 +1 @@ -routeAlias | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias routeAlias

routeAlias: {
    actionName: null | string;
    fullPath: string;
    methods: string;
    path: string;
    routePath: string;
}

Type declaration

  • actionName: null | string
  • fullPath: string
  • methods: string
  • path: string
  • routePath: string

Settings

Member Visibility

Theme

\ No newline at end of file +routeAlias | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias routeAlias

routeAlias: {
    actionName: null | string;
    fullPath: string;
    methods: string;
    path: string;
    routePath: string;
}

Type declaration

  • actionName: null | string
  • fullPath: string
  • methods: string
  • path: string
  • routePath: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.routeMiddleware.html b/types/index.MoleculerWebTypes.routeMiddleware.html index 070feae..3905e52 100644 --- a/types/index.MoleculerWebTypes.routeMiddleware.html +++ b/types/index.MoleculerWebTypes.routeMiddleware.html @@ -1 +1 @@ -routeMiddleware | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias routeMiddleware

routeMiddleware: unknown

Settings

Member Visibility

Theme

\ No newline at end of file +routeMiddleware | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias routeMiddleware

routeMiddleware: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.MoleculerWebTypes.routeMiddlewareError.html b/types/index.MoleculerWebTypes.routeMiddlewareError.html index 6cd0c0c..0212e6e 100644 --- a/types/index.MoleculerWebTypes.routeMiddlewareError.html +++ b/types/index.MoleculerWebTypes.routeMiddlewareError.html @@ -1 +1 @@ -routeMiddlewareError | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias routeMiddlewareError

routeMiddlewareError: unknown

Settings

Member Visibility

Theme

\ No newline at end of file +routeMiddlewareError | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias routeMiddlewareError

routeMiddlewareError: unknown

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/index.OA_GENERATE_DOCS_INPUT.html b/types/index.OA_GENERATE_DOCS_INPUT.html index 6fd5a21..695dbb0 100644 --- a/types/index.OA_GENERATE_DOCS_INPUT.html +++ b/types/index.OA_GENERATE_DOCS_INPUT.html @@ -1 +1 @@ -OA_GENERATE_DOCS_INPUT | @spailybot/moleculer-auto-openapi - v1.3.1

Type alias OA_GENERATE_DOCS_INPUT

OA_GENERATE_DOCS_INPUT: {}

Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +OA_GENERATE_DOCS_INPUT | @spailybot/moleculer-auto-openapi - v1.3.1

    Type alias OA_GENERATE_DOCS_INPUT

    OA_GENERATE_DOCS_INPUT: {}

    Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.OA_GENERATE_DOCS_OUTPUT.html b/types/index.OA_GENERATE_DOCS_OUTPUT.html index a6f12de..897dae2 100644 --- a/types/index.OA_GENERATE_DOCS_OUTPUT.html +++ b/types/index.OA_GENERATE_DOCS_OUTPUT.html @@ -1 +1 @@ -OA_GENERATE_DOCS_OUTPUT | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias OA_GENERATE_DOCS_OUTPUT

      OA_GENERATE_DOCS_OUTPUT: OpenAPIV3_1.Document

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +OA_GENERATE_DOCS_OUTPUT | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias OA_GENERATE_DOCS_OUTPUT

      OA_GENERATE_DOCS_OUTPUT: OpenAPIV3_1.Document

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.ObjectRules.html b/types/index.ObjectRules.html index 3c2715d..e035daf 100644 --- a/types/index.ObjectRules.html +++ b/types/index.ObjectRules.html @@ -1 +1 @@ -ObjectRules | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias ObjectRules

      ObjectRules: ValidationSchema & Record<string, ValidationRule>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +ObjectRules | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias ObjectRules

      ObjectRules: ValidationSchema & Record<string, ValidationRule>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.OpenApiMixinSettings.html b/types/index.OpenApiMixinSettings.html index 6d413f8..18138e1 100644 --- a/types/index.OpenApiMixinSettings.html +++ b/types/index.OpenApiMixinSettings.html @@ -42,4 +42,4 @@

      Var

      string action : the action name

      Var

      string autoAlias : print [autoAlias] if an auto alias

      Default

      {{summary}}\n            ({{action}}){{autoAlias}}
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.RuleToSchemaFunction.html b/types/index.RuleToSchemaFunction.html index 107f1fd..b597a68 100644 --- a/types/index.RuleToSchemaFunction.html +++ b/types/index.RuleToSchemaFunction.html @@ -1 +1 @@ -RuleToSchemaFunction | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias RuleToSchemaFunction

      RuleToSchemaFunction: ((pRule, parentProperties?) => OpenAPIV3_1.SchemaObject | undefined)

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +RuleToSchemaFunction | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias RuleToSchemaFunction

      RuleToSchemaFunction: ((pRule, parentProperties?) => OpenAPIV3_1.SchemaObject | undefined)

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.SchemaToRules.html b/types/index.SchemaToRules.html index 4d7914b..71a3db9 100644 --- a/types/index.SchemaToRules.html +++ b/types/index.SchemaToRules.html @@ -1 +1 @@ -SchemaToRules | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias SchemaToRules

      SchemaToRules: ((schema) => Record<string, OpenAPIV3_1.SchemaObject>)

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +SchemaToRules | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias SchemaToRules

      SchemaToRules: ((schema) => Record<string, OpenAPIV3_1.SchemaObject>)

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.ValidationRuleMapping.html b/types/index.ValidationRuleMapping.html index 9e641d5..9179acd 100644 --- a/types/index.ValidationRuleMapping.html +++ b/types/index.ValidationRuleMapping.html @@ -1,2 +1,2 @@ ValidationRuleMapping | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias ValidationRuleMappingInternal

      ValidationRuleMapping: {
          [K in ValidationRuleName]: K extends "any"
              ? RuleAny
              : K extends "array"
                  ? RuleArray
                  : K extends "boolean"
                      ? RuleBoolean
                      : K extends "class"
                          ? RuleClass
                          : K extends "currency"
                              ? RuleCurrency
                              : K extends "custom"
                                  ? RuleCustom
                                  : K extends "date"
                                      ? RuleDate
                                      : K extends "email"
                                          ? RuleEmail
                                          : K extends "enum"
                                              ? RuleEnum
                                              : (...) extends (...)
                                                  ? (...)
                                                  : (...)
      }

      map a Fastest-Validator rule with its type

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.actionOpenApiResponse.html b/types/index.actionOpenApiResponse.html index 72dabd3..d38beaa 100644 --- a/types/index.actionOpenApiResponse.html +++ b/types/index.actionOpenApiResponse.html @@ -5,4 +5,4 @@

      Default

      200
    • Optional type?: string

      an override of the content-type

      -

      • Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.addMappersFn.html b/types/index.addMappersFn.html index 70f1c35..2d7514b 100644 --- a/types/index.addMappersFn.html +++ b/types/index.addMappersFn.html @@ -1,2 +1,2 @@ addMappersFn | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias addMappersFn

      addMappersFn: ((getSchemaObjectFromRule, getSchemaObjectFromSchema) => ReturnOrResolve<Record<string, Mapper<RuleCustom>>>)

      Allow to add custom mappers

      -

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.definedActionSchema.html b/types/index.definedActionSchema.html index 419b99e..b931f01 100644 --- a/types/index.definedActionSchema.html +++ b/types/index.definedActionSchema.html @@ -1 +1 @@ -definedActionSchema | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias definedActionSchema

      definedActionSchema: OpenApiDefined<ActionSchema>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +definedActionSchema | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias definedActionSchema

      definedActionSchema: OpenApiDefined<ActionSchema>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.definedAliasRouteSchemaOpenApi.html b/types/index.definedAliasRouteSchemaOpenApi.html index f799397..b9705d9 100644 --- a/types/index.definedAliasRouteSchemaOpenApi.html +++ b/types/index.definedAliasRouteSchemaOpenApi.html @@ -1 +1 @@ -definedAliasRouteSchemaOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias definedAliasRouteSchemaOpenApi

      definedAliasRouteSchemaOpenApi: OpenApiDefined<AliasRouteSchemaOpenApi>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +definedAliasRouteSchemaOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias definedAliasRouteSchemaOpenApi

      definedAliasRouteSchemaOpenApi: OpenApiDefined<AliasRouteSchemaOpenApi>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.definedApiRouteSchema.html b/types/index.definedApiRouteSchema.html index f2d9850..14e9b35 100644 --- a/types/index.definedApiRouteSchema.html +++ b/types/index.definedApiRouteSchema.html @@ -1 +1 @@ -definedApiRouteSchema | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias definedApiRouteSchema

      definedApiRouteSchema: OpenApiDefined<ApiRouteSchema>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +definedApiRouteSchema | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias definedApiRouteSchema

      definedApiRouteSchema: OpenApiDefined<ApiRouteSchema>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.definedServiceSettingSchema.html b/types/index.definedServiceSettingSchema.html index 14f15cb..544d764 100644 --- a/types/index.definedServiceSettingSchema.html +++ b/types/index.definedServiceSettingSchema.html @@ -1 +1 @@ -definedServiceSettingSchema | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias definedServiceSettingSchema

      definedServiceSettingSchema: OpenApiDefined<ServiceSettingSchema>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +definedServiceSettingSchema | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias definedServiceSettingSchema

      definedServiceSettingSchema: OpenApiDefined<ServiceSettingSchema>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.filterAliasesFn.html b/types/index.filterAliasesFn.html index 83746ff..fb85daf 100644 --- a/types/index.filterAliasesFn.html +++ b/types/index.filterAliasesFn.html @@ -1,2 +1,2 @@ filterAliasesFn | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias filterAliasesFn

      filterAliasesFn: ((ctx, aliases) => ReturnOrResolve<Alias[]>)

      allow to filter aliases

      -

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.openApiServiceOpenApi.html b/types/index.openApiServiceOpenApi.html index 8d39f41..411c301 100644 --- a/types/index.openApiServiceOpenApi.html +++ b/types/index.openApiServiceOpenApi.html @@ -1 +1 @@ -openApiServiceOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias openApiServiceOpenApi

      openApiServiceOpenApi: Omit<OpenAPIV3_1.Document, "openapi" | keyof commonOpenApi> & commonOpenApi

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +openApiServiceOpenApi | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias openApiServiceOpenApi

      openApiServiceOpenApi: Omit<OpenAPIV3_1.Document, "openapi" | keyof commonOpenApi> & commonOpenApi

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.openApiTag.html b/types/index.openApiTag.html index 797a050..f037c8e 100644 --- a/types/index.openApiTag.html +++ b/types/index.openApiTag.html @@ -1 +1 @@ -openApiTag | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias openApiTag

      openApiTag: string | OpenAPIV3_1.TagObject | null

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +openApiTag | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias openApiTag

      openApiTag: string | OpenAPIV3_1.TagObject | null

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.rawHttpMethod.html b/types/index.rawHttpMethod.html index 1c055b3..9853228 100644 --- a/types/index.rawHttpMethod.html +++ b/types/index.rawHttpMethod.html @@ -1 +1 @@ -rawHttpMethod | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias rawHttpMethod

      rawHttpMethod: HTTP_METHODS | typeof JOKER_METHOD

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +rawHttpMethod | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias rawHttpMethod

      rawHttpMethod: HTTP_METHODS | typeof JOKER_METHOD

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/index.tSystemParams.html b/types/index.tSystemParams.html index 477d70e..472437f 100644 --- a/types/index.tSystemParams.html +++ b/types/index.tSystemParams.html @@ -1 +1 @@ -tSystemParams | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias tSystemParams

      tSystemParams: {
          deprecated?: boolean;
          description?: string;
          optional?: boolean;
          summary?: string;
      }

      Type declaration

      • Optional deprecated?: boolean
      • Optional description?: string
      • Optional optional?: boolean
      • Optional summary?: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +tSystemParams | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias tSystemParams

      tSystemParams: {
          deprecated?: boolean;
          description?: string;
          optional?: boolean;
          summary?: string;
      }

      Type declaration

      • Optional deprecated?: boolean
      • Optional description?: string
      • Optional optional?: boolean
      • Optional summary?: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.EOAExtensionsValues.html b/types/types_internal.EOAExtensionsValues.html index c8c32d0..2496239 100644 --- a/types/types_internal.EOAExtensionsValues.html +++ b/types/types_internal.EOAExtensionsValues.html @@ -1 +1 @@ -EOAExtensionsValues | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOAExtensionsValues

      EOAExtensionsValues: typeof EOAExtensions[keyof typeof EOAExtensions]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +EOAExtensionsValues | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOAExtensionsValues

      EOAExtensionsValues: typeof EOAExtensions[keyof typeof EOAExtensions]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.EOAOperationsExtensionTypes.html b/types/types_internal.EOAOperationsExtensionTypes.html index c8f95c0..e5a5a3c 100644 --- a/types/types_internal.EOAOperationsExtensionTypes.html +++ b/types/types_internal.EOAOperationsExtensionTypes.html @@ -1 +1 @@ -EOAOperationsExtensionTypes | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOAOperationsExtensionTypes

      EOAOperationsExtensionTypes: {
          [K in typeof EOAOperationsExtensions[keyof typeof EOAOperationsExtensions]]?: unknown
      } & {
          x-moleculer-web-server?: OpenAPIV3_1.ServerObject;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +EOAOperationsExtensionTypes | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOAOperationsExtensionTypes

      EOAOperationsExtensionTypes: {
          [K in typeof EOAOperationsExtensions[keyof typeof EOAOperationsExtensions]]?: unknown
      } & {
          x-moleculer-web-server?: OpenAPIV3_1.ServerObject;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.EOASchemaExtensionTypes.html b/types/types_internal.EOASchemaExtensionTypes.html index 0af3eaa..b996e04 100644 --- a/types/types_internal.EOASchemaExtensionTypes.html +++ b/types/types_internal.EOASchemaExtensionTypes.html @@ -1 +1 @@ -EOASchemaExtensionTypes | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOASchemaExtensionTypes

      EOASchemaExtensionTypes: {
          [K in typeof EOASchemaExtensions[keyof typeof EOASchemaExtensions]]?: unknown
      } & {
          x-fastest-deprecated?: boolean;
          x-fastest-description?: string;
          x-fastest-optional?: boolean;
          x-fastest-summary?: string;
      }

      Type declaration

      • Optional x-fastest-deprecated?: boolean
      • Optional x-fastest-description?: string
      • Optional x-fastest-optional?: boolean
      • Optional x-fastest-summary?: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +EOASchemaExtensionTypes | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOASchemaExtensionTypes

      EOASchemaExtensionTypes: {
          [K in typeof EOASchemaExtensions[keyof typeof EOASchemaExtensions]]?: unknown
      } & {
          x-fastest-deprecated?: boolean;
          x-fastest-description?: string;
          x-fastest-optional?: boolean;
          x-fastest-summary?: string;
      }

      Type declaration

      • Optional x-fastest-deprecated?: boolean
      • Optional x-fastest-description?: string
      • Optional x-fastest-optional?: boolean
      • Optional x-fastest-summary?: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.EOASchemaExtensionsValueTypes.html b/types/types_internal.EOASchemaExtensionsValueTypes.html index a920808..cbd8fd5 100644 --- a/types/types_internal.EOASchemaExtensionsValueTypes.html +++ b/types/types_internal.EOASchemaExtensionsValueTypes.html @@ -1 +1 @@ -EOASchemaExtensionsValueTypes | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOASchemaExtensionsValueTypes

      EOASchemaExtensionsValueTypes: EOASchemaExtensionTypes[keyof EOASchemaExtensionTypes]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +EOASchemaExtensionsValueTypes | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOASchemaExtensionsValueTypes

      EOASchemaExtensionsValueTypes: EOASchemaExtensionTypes[keyof EOASchemaExtensionTypes]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.EOASchemaExtensionsValues.html b/types/types_internal.EOASchemaExtensionsValues.html index 5cb0404..8b88240 100644 --- a/types/types_internal.EOASchemaExtensionsValues.html +++ b/types/types_internal.EOASchemaExtensionsValues.html @@ -1 +1 @@ -EOASchemaExtensionsValues | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOASchemaExtensionsValues

      EOASchemaExtensionsValues: typeof EOASchemaExtensions[keyof typeof EOASchemaExtensions]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +EOASchemaExtensionsValues | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias EOASchemaExtensionsValues

      EOASchemaExtensionsValues: typeof EOASchemaExtensions[keyof typeof EOASchemaExtensions]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.ExcludeFalse.html b/types/types_internal.ExcludeFalse.html index 08dc93d..ccb7591 100644 --- a/types/types_internal.ExcludeFalse.html +++ b/types/types_internal.ExcludeFalse.html @@ -1 +1 @@ -ExcludeFalse | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias ExcludeFalse<T>

      ExcludeFalse<T>: Exclude<T["openapi"], false>

      Type Parameters

      • T extends {
            openapi?: false | any;
        }

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +ExcludeFalse | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias ExcludeFalse<T>

      ExcludeFalse<T>: Exclude<T["openapi"], false>

      Type Parameters

      • T extends {
            openapi?: false | any;
        }

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.ExcludeOptionalProps.html b/types/types_internal.ExcludeOptionalProps.html index 48bc269..c7dd6d8 100644 --- a/types/types_internal.ExcludeOptionalProps.html +++ b/types/types_internal.ExcludeOptionalProps.html @@ -1,2 +1,2 @@ ExcludeOptionalProps | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias ExcludeOptionalProps<T>

      ExcludeOptionalProps<T>: Pick<T, RequiredKeys<T>>

      allow to exclude optional props from a type

      -

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.ExcludeRequiredProps.html b/types/types_internal.ExcludeRequiredProps.html index a653058..1a31980 100644 --- a/types/types_internal.ExcludeRequiredProps.html +++ b/types/types_internal.ExcludeRequiredProps.html @@ -1,2 +1,2 @@ ExcludeRequiredProps | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias ExcludeRequiredProps<T>

      ExcludeRequiredProps<T>: Pick<T, OptionalKeys<T>>

      allow to exclude required props from a type

      -

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.OpenApiDefined.html b/types/types_internal.OpenApiDefined.html index 9ec9c60..4fcb37e 100644 --- a/types/types_internal.OpenApiDefined.html +++ b/types/types_internal.OpenApiDefined.html @@ -1,2 +1,2 @@ OpenApiDefined | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias OpenApiDefined<T>

      OpenApiDefined<T>: Omit<T, "openapi"> & {
          openapi?: ExcludeFalse<T>;
      }

      just to remove the | false on openapi keys . ( allow input "| false" , but need without "| false" when used )

      -

      Type Parameters

      • T extends {
            openapi?: false | any;
        }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      • T extends {
            openapi?: false | any;
        }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.OptionalKeys.html b/types/types_internal.OptionalKeys.html index 7dea153..6a28ce7 100644 --- a/types/types_internal.OptionalKeys.html +++ b/types/types_internal.OptionalKeys.html @@ -1 +1 @@ -OptionalKeys | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias OptionalKeys<T>

      OptionalKeys<T>: {
          [K in keyof T]-?: {} extends {
                  [P in K]: T[K]
              }
              ? K
              : never
      }[keyof T]

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +OptionalKeys | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias OptionalKeys<T>

      OptionalKeys<T>: {
          [K in keyof T]-?: {} extends {
                  [P in K]: T[K]
              }
              ? K
              : never
      }[keyof T]

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.OptionalOrFalse.html b/types/types_internal.OptionalOrFalse.html index 7316722..6d6f763 100644 --- a/types/types_internal.OptionalOrFalse.html +++ b/types/types_internal.OptionalOrFalse.html @@ -2,4 +2,4 @@

      Type Parameters

      • T

        the Record where all keys can be falsifiable

      Example

      type myType = {
        foo: string;
        bar: string;
      }

      type myFalsifiableType = OptionalOrFalse<myType>;
      myFalsifiableType = {
          foo?: string | false;
          bar?: string | false;
      }
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.RequiredKeys.html b/types/types_internal.RequiredKeys.html index 9389f62..a124ea2 100644 --- a/types/types_internal.RequiredKeys.html +++ b/types/types_internal.RequiredKeys.html @@ -1 +1 @@ -RequiredKeys | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias RequiredKeys<T>

      RequiredKeys<T>: {
          [K in keyof T]-?: {} extends {
                  [P in K]: T[K]
              }
              ? never
              : K
      }[keyof T]

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +RequiredKeys | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias RequiredKeys<T>

      RequiredKeys<T>: {
          [K in keyof T]-?: {} extends {
                  [P in K]: T[K]
              }
              ? never
              : K
      }[keyof T]

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.ReturnOrResolve.html b/types/types_internal.ReturnOrResolve.html index eff8d7a..95995e8 100644 --- a/types/types_internal.ReturnOrResolve.html +++ b/types/types_internal.ReturnOrResolve.html @@ -1,2 +1,2 @@ ReturnOrResolve | @spailybot/moleculer-auto-openapi - v1.3.1

      Type alias ReturnOrResolve<T>

      ReturnOrResolve<T>: T | Promise<T>

      allow to return a promise or not

      -

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types_internal.SubOptionalOrFalse.html b/types/types_internal.SubOptionalOrFalse.html index 1ebb65e..b91af98 100644 --- a/types/types_internal.SubOptionalOrFalse.html +++ b/types/types_internal.SubOptionalOrFalse.html @@ -2,4 +2,4 @@

      Type Parameters

      • T

        the Record where all sub keys can be falsifiable

      Example

      type myType = {
          foo: {
            foo: string;
            bar: string;
          }
      }

      type myFalsifiableType = SubOptionalOrFalse<myType>;
      /**
        myFalsifiableType = {
          foo: {
            foo?: string | false;
            bar?: string | false;
          }
      }
      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/variables/index.JOKER_METHOD.html b/variables/index.JOKER_METHOD.html index be0d5bb..ec1442e 100644 --- a/variables/index.JOKER_METHOD.html +++ b/variables/index.JOKER_METHOD.html @@ -1 +1 @@ -JOKER_METHOD | @spailybot/moleculer-auto-openapi - v1.3.1

      Variable JOKER_METHODConst

      JOKER_METHOD: "*" = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +JOKER_METHOD | @spailybot/moleculer-auto-openapi - v1.3.1

      Variable JOKER_METHODConst

      JOKER_METHOD: "*" = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/variables/index.OPENAPI_VERSIONS_SUPPORTED.html b/variables/index.OPENAPI_VERSIONS_SUPPORTED.html index 12223c3..9137221 100644 --- a/variables/index.OPENAPI_VERSIONS_SUPPORTED.html +++ b/variables/index.OPENAPI_VERSIONS_SUPPORTED.html @@ -1 +1 @@ -OPENAPI_VERSIONS_SUPPORTED | @spailybot/moleculer-auto-openapi - v1.3.1

      Variable OPENAPI_VERSIONS_SUPPORTEDConst

      OPENAPI_VERSIONS_SUPPORTED: readonly ["3.1"] = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +OPENAPI_VERSIONS_SUPPORTED | @spailybot/moleculer-auto-openapi - v1.3.1

      Variable OPENAPI_VERSIONS_SUPPORTEDConst

      OPENAPI_VERSIONS_SUPPORTED: readonly ["3.1"] = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/variables/index.OpenApiMixin.html b/variables/index.OpenApiMixin.html index 2a22b11..893926f 100644 --- a/variables/index.OpenApiMixin.html +++ b/variables/index.OpenApiMixin.html @@ -1 +1 @@ -OpenApiMixin | @spailybot/moleculer-auto-openapi - v1.3.1

      Variable OpenApiMixinConst

      OpenApiMixin: ServiceSchema<ServiceSettingSchema> = mixin

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +OpenApiMixin | @spailybot/moleculer-auto-openapi - v1.3.1

      Variable OpenApiMixinConst

      OpenApiMixin: ServiceSchema<ServiceSettingSchema> = mixin

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/variables/index.mixin.html b/variables/index.mixin.html index 9357280..78d5dcf 100644 --- a/variables/index.mixin.html +++ b/variables/index.mixin.html @@ -1 +1 @@ -mixin | @spailybot/moleculer-auto-openapi - v1.3.1

      Variable mixinConst

      mixin: ServiceSchema<ServiceSettingSchema> = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +mixin | @spailybot/moleculer-auto-openapi - v1.3.1

      Variable mixinConst

      mixin: ServiceSchema<ServiceSettingSchema> = ...

      Settings

      Member Visibility

      Theme

      \ No newline at end of file