UNPKG

1.46 kBTypeScriptView Raw
1/**
2 * Simple utility functions
3 * @module util
4 */
5/// <reference types="lodash" />
6/**
7 * Mark a piece of code as deprecated.
8 *
9 * Each deprecation notice for a given name and version combination will
10 * only be printed once.
11 *
12 * @param {string} name - the name of the function / method / class to deprecate
13 * @param {string} version - the version after which the code will be marked
14 * as deprecated
15 * @param {string} [alternative] - the function / method / class to use instead
16 * of this deprecated code
17 *
18 * @alias module:util
19 */
20export declare const deprecate: (name: string, version: string, alternative?: string | undefined) => void;
21/**
22 * Remove properties whose values are `null` or `undefined`
23 *
24 * @param {Object} obj - object to update
25 * @returns {Object} a shallow clone of the object with `null` and `undefined`
26 * properties removed
27 *
28 * @alias module:util
29 */
30export declare const removeNilProperties: <T extends object>(obj: T) => import("lodash").Dictionary<any>;
31/**
32 * Test if a value is included in a list of items
33 *
34 * This is a curried function - https://lodash.com/docs/4.17.11#curry
35 *
36 * @param {Array} collection - the list of items to check against
37 * @param {Object} val - the item to check for in the collection
38 * @returns {boolean}
39 *
40 * @alias module:util
41 * @kind function
42 */
43export declare const isOneOf: import("lodash").CurriedFunction2<unknown[], unknown, boolean>;
44//# sourceMappingURL=util.d.ts.map
\No newline at end of file