Class Range

Range represents a byte range in etcd. Parts of this class are based on the logic found internally within etcd here: https://github.com/coreos/etcd/blob/c4a45c57135bf49ae701352c9151dc1be433d1dd/pkg/adt/interval_tree.go

Index

Constructors

Properties

Methods

compare includes from prefix

Constructors

constructor

new Range(
start: string | Buffer<ArrayBufferLike>,
end?: string | Buffer<ArrayBufferLike>,
): Range
Parameters
- start: string | Buffer<ArrayBufferLike>
- end: string | Buffer<ArrayBufferLike> = emptyKey
Returns Range
- Defined in src/range.ts:81

Properties

`Readonly`end

end: Buffer

`Readonly`start

start: Buffer

Methods

compare

compare(other: Range): number
Compares the other range to this one, returning: -1 if this range comes before the other one 1 if this range comes after the other one 0 if they overlap
Parameters
- other: Range
Returns number
- Defined in src/range.ts:100

includes

includes(value: string | Buffer<ArrayBufferLike>): boolean
Returns whether the byte range includes the provided value.
Parameters
- value: string | Buffer<ArrayBufferLike>
Returns boolean
- Defined in src/range.ts:89

`Static`from

from(v: Rangable): Range
Converts a rangable into a qualified Range.
Parameters
- v: Rangable
Returns Range
- Defined in src/range.ts:59

`Static`prefix

prefix(prefix: string | Buffer<ArrayBufferLike>): Range
Prefix returns a Range that maps to all keys prefixed with the provided string.
Parameters
- prefix: string | Buffer<ArrayBufferLike>
Returns Range
- Defined in src/range.ts:48