@AppKu/StashKu

@AppKu/StashKu

v1.0.46

Class

PutRequest

This class defines a StashKu PUT request that instructs StashKu to update existing objects in storage.

Constructor

new PutRequest(pkopt, …objectsopt)

Creates a new PutRequest instance. A PUT request instructs StashKu to update existing objects in storage.

Parameters

  • pk Array.<String> <optional>

    The property name(s) that are used to uniquely identify each object.

  • objects M <optional>
    <repeatable>

    Spread of objects to create in update in storage.

Source

Members

Methods

count(enabledopt) → {module:requests/put-request~PutRequest.<M>}

Requests that the response return count numbers (total, affected, returned, etc.) but not objects.

This will result in a Response with an empty data array and may result in faster query execution if you only need the resulting numbers.

Calling this function without an argument enables the flag.

Parameters

  • enabled Boolean <optional>
     true

    A true enables the count-only result. A false disables it.

Returns

Source

headers(dictionary) → {module:requests/put-request~PutRequest.<M>}

Sets or clears headers on the request that can be used to set engine-specific options for the request. If a null value is passed, the headers are cleared.

Parameters

  • dictionary Object | Map.<String, *>

    A map or object defining the headers and values.

Returns

Throws

  1. Error when the dictionary argument uses a non-string key.

  2. Error when the dictionary argument is not an object, null, or a Map.

Source

objects(…objectsopt) → {module:requests/put-request~PutRequest.<M>}

Adds objects to the PUT request. If any object has already been added to the request, it is skipped.
If a single null value is passed, all objects are cleared from the request.

Parameters

  • objects M <optional>
    <repeatable>

    Spread of objects to update in data storage, as matched by pk property values.

Returns

Source