# @types/get-value

> TypeScript definitions for get-value

Latest version **3.0.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/get-value
pnpm add @types/get-value
yarn add @types/get-value
bun add @types/get-value
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.5 |
| Published | 2023-11-07 |
| First published | 2018-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/get-value
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/get-value
- npm.io page: https://npm.io/package/@types/get-value

## Recent versions

- 3.0.5 (latest) — 2023-11-07
- 3.0.3 (ts4.0) — 2022-08-15
- 3.0.2 (ts3.6) — 2021-07-06
- 3.0.1 (ts2.4) — 2019-03-28
- 3.0.4 — 2023-10-18
- 3.0.0 — 2018-02-22

## README

# Installation
> `npm install --save @types/get-value`

# Summary
This package contains type definitions for get-value (https://github.com/jonschlinkert/get-value).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/get-value.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/get-value/index.d.ts)
````ts
export = get;

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

declare namespace get {
    interface Options {
        /**
         * The default value to return when get-value cannot result a value from the given object.
         *
         * default: `undefined`
         */
        default?: any;
        /**
         * If defined, this function is called on each resolved value.
         * Useful if you want to do `.hasOwnProperty` or `Object.prototype.propertyIsEnumerable`.
         */
        isValid?: (<K extends string>(key: K, object: Record<K, any>) => boolean) | undefined;
        /**
         * Custom function to use for splitting the string into object path segments.
         *
         * default: `String.split`
         */
        split?: ((s: string) => string[]) | undefined;
        /**
         * The separator to use for spliting the string.
         * (this is probably not needed when `options.split` is used).
         *
         *  default: `"."`
         */
        separator?: string | RegExp | undefined;
        /**
         * Customize how the object path is created when iterating over path segments.
         *
         * default: `Array.join`
         */
        join?: ((segs: string[]) => 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: `"."`
         */
        joinChar?: string | undefined;
    }
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

# Credits
These definitions were written by [Daniel Rosenwasser](https://github.com/DanielRosenwasser).

---
_Source: https://npm.io/package/@types/get-value · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._