Interface IAddApiResponseMessageOptions

Options for adding a message to a response.

interface IAddApiResponseMessageOptions {
    code?: Nilable<number>;
    id?: Nilable<string>;
    internal?: boolean;
    message: string;
    type?: Nilable<ApiResponseMessageType>;
}

Properties

code? id? internal? message type?

Properties

Optional code

code?: Nilable<number>

A human-readble error code.

Optional id

id?: Nilable<string>

The unique ID of an entry in a database, e.g.

Optional internal

internal?: boolean

Indicates if it an internal message or a message, which can be read be an user.

message

message: string

The message text.

Optional type

type?: Nilable<ApiResponseMessageType>

The type. Default: 'info'

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc