Interface OrderDefaultAdapterOptions

Order default adapter options

interface OrderDefaultAdapterOptions {
    authEncSecret: string;
    authSignSecret: string;
    authenticate?: AuthenticationFunction;
    customFields?: {
        order?: CustomField[];
    };
    paginationConfiguration?: PaginationConfigurations;
    serviceEndpoints: {
        order: string;
    };
    taxPercent?: number;
}

Properties

authEncSecret authSignSecret authenticate? customFields? paginationConfiguration? serviceEndpoints taxPercent?

Properties

authEncSecret

authEncSecret: string

Secret use to encrypt the JWT Token

authSignSecret

authSignSecret: string

Secret use to sign the JWT Token

Optional authenticate

authenticate?: AuthenticationFunction

Function that will be called to authenticate the user via validators. When not provided, this will default to the default for the given authType.

Typically you would only provide this if designing your own authentication.

Optional customFields

customFields?: {
    order?: CustomField[];
}

Custom field configuration for each data type

Type declaration

  • Optional order?: CustomField[]

Optional paginationConfiguration

paginationConfiguration?: PaginationConfigurations

Default pagination configuration for each of the list endpoints

serviceEndpoints

serviceEndpoints: {
    order: string;
}

Endpoints for different services Used in the API when returning links to services.

Type declaration

  • order: string

Optional taxPercent

taxPercent?: number

Percentage tax to use in total calculations

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc