Interface LimeObjectRepository

Hierarchy

Methods

deleteObject getObject? getObjects? getSchema? loadObject loadObjects loadRelations loadSchema subscribe

Methods

deleteObject

  • Delete the specified limeobject

    Parameters

    • limetype: string

      name of the limetype of the limeobject

    • id: number

      the id of the limeobject

    Returns Promise<void>

Optional getObject

  • Beta

    Get an already loaded LimeObject

    Returns

    the LimeObject if it is loaded, otherwise undefined

    Parameters

    • limetype: string

      name of the limetype

    • id: number

      the id of the object

    Returns LimeObject

Optional getObjects

  • Beta

    Get all loaded LimeObjects of a specific limetype

    Returns

    list of loaded LimeObjects

    Parameters

    • limetype: string

      name of the limetype

    Returns LimeObject[]

Optional getSchema

  • Get a schema that is already loaded for the limetype.

    Type Parameters

    • TSchemaType extends Record<string, any> = object

    Parameters

    • limetype: string

      name of the limetype of the owning limeobject

    Returns TSchemaType

loadObject

  • Load the specified limeobject into the state

    Parameters

    • limetype: string
    • id: number
    • Optional options: Pick<LoadOptions, "properties">

    Returns void

loadObjects

  • Load objects of the specified limetype into the state

    Returns

    list of objects together with total count of objects

    Parameters

    • limetype: string

      name of the limetype

    • Optional options: LoadOptions

      options about the objects to load

    Returns Promise<ObjectResponse>

loadRelations

  • Load related objects into the state

    Returns

    list of related objects together with total count of objects

    Parameters

    • limetype: string

      name of the limetype of the owning limeobject

    • id: number

      the id of the owning limeobject

    • property: string

      name of the property that contain the relations

    • Optional options: LoadOptions

      options about the objects to load

    Returns Promise<ObjectResponse>

loadSchema

  • Loads a schema for the limetype.

    Type Parameters

    • TSchemaType extends Record<string, any> = object

    Parameters

    • limetype: string

      name of the limetype of the owning limeobject

    Returns Promise<TSchemaType>

subscribe

  • Subscribe to state changes

    Returns

    unsubscribe callback

    Parameters

    • callback: ((...args: unknown[]) => void)

      function to call when subscription updates

        • (...args: unknown[]): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    • Optional options: StateOptions

      options for the state selector

    Returns (() => void)

      • (): void

      • Subscribe to state changes

        Returns

        unsubscribe callback

        Returns void

Settings

Member Visibility

Theme