mise API - v0.0.0
    Preparing search index...

    Interface ItemResource

    API abstract item resource class.

    interface ItemResource {
        auth: Object;
        collection: Object | null;
        contentType: string;
        url: string;
        get data(): Object | null;
        get isEmpty(): boolean;
        _delete(timeout?: number): Promise<any>;
        _getResource(
            linkRelation: string,
            ResourceClass: Object,
            searchParams?: { limit?: number; offset?: number },
            timeout?: number,
        ): Promise<Object>;
        _put(
            data: Object,
            uploadFileObj: Object | null,
            timeout?: number,
        ): Promise<ItemResource>;
        clone(): Resource;
        get(timeout?: number): Promise<ItemResource>;
        getPUTParameters(): string[] | null;
    }

    Hierarchy (View Summary)

    Index
    auth collection contentType url
    data isEmpty
    _delete _getResource _put clone get getPUTParameters
    auth: Object
    collection: Object | null
    contentType: string
    url: string
    • get data(): Object | null

      Get the item's data object (REST API descriptors).

      Returns Object | null

    • get isEmpty(): boolean

      Return true if the resource object contains any data.

      Returns boolean

    _delete

    • _delete(timeout?: number): Promise<any>

      Internal helper method to make a DELETE request to this item resource through the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<any>

      • JS Promise

    _getResource

    • _getResource(
          linkRelation: string,
          ResourceClass: Object,
          searchParams?: { limit?: number; offset?: number },
          timeout?: number,
      ): Promise<Object>

      Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.

      Parameters

      • linkRelation: string
      • ResourceClass: Object
      • OptionalsearchParams: { limit?: number; offset?: number }

        search parameters object which is resource-specific

        • Optionallimit?: number

          page limit

        • Optionaloffset?: number

          page offset

      • Optionaltimeout: number

        request timeout

      Returns Promise<Object>

      • JS Promise, resolves to a ResourceClass object

      throw error if this item resource has not yet been fetched from the REST API

      throw error when the link relation is not found

    _put

    • _put(
          data: Object,
          uploadFileObj: Object | null,
          timeout?: number,
      ): Promise<ItemResource>

      Internal helper method to make a PUT request to this item resource through the REST API.

      Parameters

      • data: Object

        request JSON data object

      • uploadFileObj: Object | null

        custom file object

        • Object
          • fname

            file blob

        • null
      • Optionaltimeout: number

        request timeout

      Returns Promise<ItemResource>

      • JS Promise, resolves to this object

    • Make a deep copy clone of this object resource.

      Returns Resource

      • clone object

    • Fetch this item resource from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<ItemResource>

      • JS Promise, resolves to this object

    • Get an array of parameter names that can be used as properties of the data object in PUT requests.

      Returns string[] | null

      • array of PUT data property name or null if this list resource's data has not been fetched from the API yet or it doesn't support PUT requests.

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods