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>

getObject

  • 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

getObjects

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 with optional transformation and filtering.

    The subscription will immediately invoke the callback with the current state (if any), then continue to call it whenever the state changes. The map and filter options allow you to transform and selectively receive updates.

    Returns

    Unsubscribe function - call this to stop receiving updates

    Remarks

    • Map functions are applied sequentially to transform the state
    • Filter functions must all return true for the callback to be invoked
    • Functions in map/filter arrays are bound to the component instance
    • Always store and call the unsubscribe function when component is destroyed

    Example

    // Basic subscription
    const unsubscribe = repository.subscribe((state) => {
        console.log('State updated:', state);
    });

    // With transformations
    const unsubscribe = repository.subscribe(
        (userName) => console.log('User:', userName),
        { map: [(state) => state.user?.name] }
    );

    Parameters

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

      Function called with state updates (after map/filter applied)

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

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    • Optional options: StateOptions

      Optional transformations and filters for the subscription

    Returns (() => void)

      • (): void

      • Subscribe to state changes with optional transformation and filtering.

        The subscription will immediately invoke the callback with the current state (if any), then continue to call it whenever the state changes. The map and filter options allow you to transform and selectively receive updates.

        Returns

        Unsubscribe function - call this to stop receiving updates

        Remarks

        • Map functions are applied sequentially to transform the state
        • Filter functions must all return true for the callback to be invoked
        • Functions in map/filter arrays are bound to the component instance
        • Always store and call the unsubscribe function when component is destroyed

        Example

        // Basic subscription
        const unsubscribe = repository.subscribe((state) => {
            console.log('State updated:', state);
        });

        // With transformations
        const unsubscribe = repository.subscribe(
            (userName) => console.log('User:', userName),
            { map: [(state) => state.user?.name] }
        );

        Returns void

Settings

Member Visibility

Theme