OINO TS
    Preparing search index...

    Type Alias OINODbApiParams

    API parameters

    type OINODbApiParams = {
        apiName: string;
        cacheModifiedField?: string;
        excludeFieldPrefix?: string;
        excludeFields?: string[];
        failOnAnyInvalidRows?: boolean;
        failOnInsertWithoutKey?: boolean;
        failOnOversizedValues?: Boolean;
        failOnUpdateOnAutoinc?: boolean;
        hashidKey?: string;
        hashidLength?: number;
        hashidStaticIds?: boolean;
        includeFields?: string[];
        tableName: string;
        useDatesAsString?: Boolean;
    }
    Index

    Properties

    apiName cacheModifiedField? excludeFieldPrefix? excludeFields? failOnAnyInvalidRows? failOnInsertWithoutKey? failOnOversizedValues? failOnUpdateOnAutoinc? hashidKey? hashidLength? hashidStaticIds? includeFields? tableName useDatesAsString?

    Properties

    apiName: string

    Name of the api

    cacheModifiedField?: string

    Name of field that has the modified field

    excludeFieldPrefix?: string

    Exclude all fields with this prefix from the API

    excludeFields?: string[]

    Exclude given fields from the API and include rest (if defined)

    failOnAnyInvalidRows?: boolean

    Reject POST-requests without primary key value (can work if DB-side )

    failOnInsertWithoutKey?: boolean

    Reject POST-requests without primary key value (can work if DB-side )

    failOnOversizedValues?: Boolean

    Reject values that exceed field max length (behaviour on such is platform dependent)

    failOnUpdateOnAutoinc?: boolean

    Reject PUT-requests that contain values for autoinc-type fields

    hashidKey?: string

    Enable hashids for numeric primarykeys by adding a 32 char key

    hashidLength?: number

    Set (minimum) length (12-32 chars) of the hashids

    hashidStaticIds?: boolean

    Make hashids static per row/table

    includeFields?: string[]

    Include given fields from the API and exclude rest (if defined)

    tableName: string

    Name of the database table

    useDatesAsString?: Boolean

    Treat date type fields as just strings and use the native formatting instead of the ISO 8601 format

    Settings

    Member Visibility

    On This Page

    Properties