Skip to content

Commit

Permalink
Merge pull request #31 from icebreaker-forked/master
Browse files Browse the repository at this point in the history
fix: dist/index.mjs missing in 4.0.0 #30 and missing index.d.ts #28
  • Loading branch information
jonschlinkert authored Feb 5, 2025
2 parents 9f0735c + 5d20cec commit b91c776
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
47 changes: 47 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
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;
}
}
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,16 @@
"tsup": "npx tsup"
},
"files": [
"dist/index.js"
"dist/index.js",
"dist/index.mjs",
"index.d.ts"
],
"main": "dist/index.js",
"module": "dist/index.mjs",
"types": "index.d.ts",
"exports": {
".": {
"types": "./index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.js"
}
Expand Down

0 comments on commit b91c776

Please sign in to comment.