@AppKu/StashKu

@AppKu/StashKu

v1.0.46

Class

DeleteRequest

This class defines a StashKu DELETE request that instructs StashKu to delete objects matching the specified criteria.

Constructor

new DeleteRequest()

Creates a new DeleteRequest instance. A DELETE request instructs StashKu to delete objects from storage that match the specified criteria.

Source

Members

Methods

all(enabled) → {DeleteRequest}

Enables the deletion of all objects in data storage if no where conditions are specified. If conditions are specified, this setting will be ignored.

Caling this method without an argument will set the request to enable the update of all objects.

Parameters

  • enabled Boolean

    Enable or disable the deletion of all records.

Returns

Source

count(enabledopt) → {GetRequest}

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

from(name) → {DeleteRequest}

Sets the target resource name for the request, optionally specifying an alias for use with specifying properties across joins.

Parameters

  • name String

    The name of the target resource in data storage.

Returns

Throws

Error if the "name" argument value is not a string or null.

Source

headers(dictionary) → {DeleteRequest}

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

where(conditions) → {DeleteRequest}

Creates a set of conditions on the request to match specific objects in storage.
Any existing where conditions will be overwritten.
If a null value is passed, the where conditions are cleared.

Parameters

Returns

Throws

Error if the "conditions" argument must be null or a Filter instance.

Source