ordered-binary 1.2.5 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -2,10 +2,10 @@ type Key = Key[] | string | symbol | number | boolean | Uint8Array;
2
2
  /** Writes a key (a primitive value) to the target buffer, starting at the given position */
3
3
  export function writeKey(key: Key, target: Uint8Array, position: number, inSequence?: boolean): number;
4
4
  /** Reads a key from the provided buffer, from the given range */
5
- export function readKey(buffer: Uint8Array, start: number, end: number, inSequence?: boolean): Key;
5
+ export function readKey(buffer: Uint8Array, start: number, end?: number, inSequence?: boolean): Key;
6
6
  /** Converts key to a Buffer. This is generally much slower than using writeKey since it involves a full buffer allocation, and should be avoided for performance sensitive code. */
7
7
  export function toBufferKey(key: Key): Buffer;
8
- /** Coverts Buffer to Key */
8
+ /** Converts Buffer to Key */
9
9
  export function fromBufferKey(source: Buffer): Key;
10
10
  /** Compares two keys, returning -1 if `a` comes before `b` in the ordered binary representation of the keys, or 1 if `a` comes after `b`, or 0 if they are equivalent */
11
11
  export function compareKeys(a: Key, b: Key): number;