@types/get-value

Install

npm i @types/get-value

yarn add @types/get-value

pnpm add @types/get-value

TypeScript definitions for get-value

get: {
    <T>(obj: T): T;
    (obj: object, key: string | string[], options?: get.Options): any;
};

interface Options {}

default?: any;

The default value to return when get-value cannot result a value from the given object.
default: undefined

isValid?:
    | (<K extends string>(key: K, object: Record<K, any>) => boolean)
    | undefined;

If defined, this function is called on each resolved value. Useful if you want to do .hasOwnProperty or Object.prototype.propertyIsEnumerable.

join?: ((segs: string[]) => string) | undefined;

Customize how the object path is created when iterating over path segments.
default: Array.join

joinChar?: string | undefined;

The character to use when re-joining the string to check for keys with dots in them (this is probably not needed when options.join is used). This can be a different value than the separator, since the separator can be a string or regex.
default: "."

separator?: string | RegExp | undefined;

The separator to use for spliting the string. (this is probably not needed when options.split is used).
default: "."

split?: ((s: string) => string[]) | undefined;

Custom function to use for splitting the string into object path segments.
default: String.split

No dependencies.

No dev dependencies.

No peer dependencies.

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/get-value.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/get-value)

HTML

<a href="https://www.jsdocs.io/package/@types/get-value"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>