@resistdesign/voltra
    Preparing search index...

    Type Alias TypeInfoORMAPI

    Server-side TypeInfoORM API contract.

    Methods that perform DAC-sensitive work may accept context?: TypeInfoORMContext.

    type TypeInfoORMAPI = {
        create: (typeName: string, item: TypeInfoDataItem) => Promise<any>;
        createRelationship: (
            relationshipItem: BaseItemRelationshipInfo,
            context?: TypeInfoORMContext,
        ) => Promise<boolean>;
        delete: (
            typeName: string,
            primaryFieldValue: any,
            context?: TypeInfoORMContext,
        ) => Promise<boolean>;
        deleteRelationship: (
            relationshipItem: BaseItemRelationshipInfo,
            context?: TypeInfoORMContext,
        ) => Promise<DeleteRelationshipResults>;
        list: (
            typeName: string,
            config: ListItemsConfig,
            selectedFields?: (keyof TypeInfoDataItem)[],
            context?: TypeInfoORMContext,
        ) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>;
        listRelatedItems: (
            config: ListRelationshipsConfig,
            selectedFields?: (keyof TypeInfoDataItem)[],
            context?: TypeInfoORMContext,
        ) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>;
        listRelationships: (
            config: ListRelationshipsConfig,
            context?: TypeInfoORMContext,
        ) => Promise<ListItemsResults<ItemRelationshipInfo>>;
        read: (
            typeName: string,
            primaryFieldValue: any,
            selectedFields?: (keyof TypeInfoDataItem)[],
            context?: TypeInfoORMContext,
        ) => Promise<Partial<TypeInfoDataItem>>;
        update: (
            typeName: string,
            item: TypeInfoDataItem,
            updateConfig?: TypeInfoORMUpdateConfig,
            context?: TypeInfoORMContext,
        ) => Promise<boolean>;
    }

    Implemented by

    Index

    Properties

    create createRelationship delete deleteRelationship list listRelatedItems listRelationships read update

    Properties

    create: (typeName: string, item: TypeInfoDataItem) => Promise<any>

    Create an item.

    Type Declaration

      • (typeName: string, item: TypeInfoDataItem): Promise<any>

      • Parameters

        • typeName: string

          Type name to create.

        • item: TypeInfoDataItem

          Item payload to create.

        Returns Promise<any>

        The created item result.

    createRelationship: (
        relationshipItem: BaseItemRelationshipInfo,
        context?: TypeInfoORMContext,
    ) => Promise<boolean>

    Create a relationship record.

    Type Declaration

      • (
            relationshipItem: BaseItemRelationshipInfo,
            context?: TypeInfoORMContext,
        ): Promise<boolean>

      • Parameters

        • relationshipItem: BaseItemRelationshipInfo

          Relationship payload to create.

        • Optionalcontext: TypeInfoORMContext

        Returns Promise<boolean>

        Whether the create succeeded.

    delete: (
        typeName: string,
        primaryFieldValue: any,
        context?: TypeInfoORMContext,
    ) => Promise<boolean>

    Delete an item by primary field value.

    Type Declaration

      • (
            typeName: string,
            primaryFieldValue: any,
            context?: TypeInfoORMContext,
        ): Promise<boolean>

      • Parameters

        • typeName: string

          Type name to delete.

        • primaryFieldValue: any

          Primary field value to delete.

        • Optionalcontext: TypeInfoORMContext

        Returns Promise<boolean>

        Whether the delete succeeded.

    deleteRelationship: (
        relationshipItem: BaseItemRelationshipInfo,
        context?: TypeInfoORMContext,
    ) => Promise<DeleteRelationshipResults>

    Delete a relationship record.

    Type Declaration

    list: (
        typeName: string,
        config: ListItemsConfig,
        selectedFields?: (keyof TypeInfoDataItem)[],
        context?: TypeInfoORMContext,
    ) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>

    List items matching the configuration.

    Type Declaration

    listRelatedItems: (
        config: ListRelationshipsConfig,
        selectedFields?: (keyof TypeInfoDataItem)[],
        context?: TypeInfoORMContext,
    ) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>

    List related items for a relationship query.

    Type Declaration

    listRelationships: (
        config: ListRelationshipsConfig,
        context?: TypeInfoORMContext,
    ) => Promise<ListItemsResults<ItemRelationshipInfo>>

    List relationships matching the query.

    Type Declaration

    read: (
        typeName: string,
        primaryFieldValue: any,
        selectedFields?: (keyof TypeInfoDataItem)[],
        context?: TypeInfoORMContext,
    ) => Promise<Partial<TypeInfoDataItem>>

    Read an item by primary field value.

    Type Declaration

    update: (
        typeName: string,
        item: TypeInfoDataItem,
        updateConfig?: TypeInfoORMUpdateConfig,
        context?: TypeInfoORMContext,
    ) => Promise<boolean>

    Update an item.

    Type Declaration

    Settings

    Member Visibility

    On This Page

    Properties