Type alias OINODbApiParams

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;
}

API parameters

Type declaration

  • apiName: string

    Name of the api

  • Optional cacheModifiedField?: string

    Name of field that has the modified field

  • Optional excludeFieldPrefix?: string

    Exclude all fields with this prefix from the API

  • Optional excludeFields?: string[]

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

  • Optional failOnAnyInvalidRows?: boolean

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

  • Optional failOnInsertWithoutKey?: boolean

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

  • Optional failOnOversizedValues?: Boolean

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

  • Optional failOnUpdateOnAutoinc?: boolean

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

  • Optional hashidKey?: string

    Enable hashids for numeric primarykeys by adding a 32 char key

  • Optional hashidLength?: number

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

  • Optional hashidStaticIds?: boolean

    Make hashids static per row/table

  • Optional includeFields?: string[]

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

  • tableName: string

    Name of the database table

  • Optional useDatesAsString?: Boolean

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

Settings

Member Visibility

Theme