@types/record-locator

Installation

npm install --save @types/record-locator

Summary

This package contains type definitions for record-locator (https://github.com/dkhr/record-locator).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/record-locator.

index.d.ts

/**
 * Encodes an integer into a record locator string
 *
 * @param recordLocator must be a positive integer
 * @throws Error when called with a `recordLocator` parameter that is undefined/not a number or a negative number
 */
export function encode(recordLocator: number): string;

/**
 * Decodes a record locator string back into an integer
 *
 * @param recordLocator
 * @throws Error when called with a `recordLocator` parameter that is undefined
 */
export function decode(recordLocator: string): number;

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by Moritz Hein.