Interface Patch

Represents the changes needed for a PATCH request.

interface Patch {
    binary: boolean;
    data: Guarded<Readable>;
    isEmpty: boolean;
    metadata: RepresentationMetadata;
}

Hierarchy (view full)

Properties

binary data isEmpty metadata

Properties

binary

binary: boolean

Whether the data stream consists of binary/string chunks (as opposed to complex objects).

data

data: Guarded<Readable>

The raw data stream for this representation.

isEmpty

isEmpty: boolean

Whether the data stream is empty. This being true does not imply that the data stream has a length of more than 0, only that it is a possibility and should be read to be sure.

metadata

metadata: RepresentationMetadata

The corresponding metadata.

Settings

Member Visibility

On This Page

Properties