UNPKG

@barchart/common-js

Version:

Library of common JavaScript utilities

github.com/barchart/barchart-common-js

barchart/barchart-common-js

53 lines (52 loc) • 2.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/** * Utilities for reading and writing "complex" properties to * objects. For example, the property "name.first" reads the * "first" property on the "name" object of the target. * * @public * @module lang/attributes */ /** * Checks to see if an attribute exists on the target object. * * @public * @static * @param {object} target - The object to check for existence of the property. * @param {string|string[]} propertyNames - The property to check -- either a string with separators, or an array of strings (already split by separator). * @param {string=} separator - The separator (defaults to a period character). * @returns {boolean} */ export function has(target: object, propertyNames: string | string[], separator?: string | undefined): boolean; /** * Returns a value from the target object. If the property doesn't exist; undefined * is returned. * * @public * @static * @param {object} target - The object to read from. * @param {string|string[]} propertyNames - The property to read -- either a string with separators, or an array of strings (already split by separator). * @param {string=} separator - The separator (defaults to a period character). * @returns {*} */ export function read(target: object, propertyNames: string | string[], separator?: string | undefined): any; /** * Writes a value to the target object. * * @public * @static * @param {object} target - The object to write to. * @param {string|string[]} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator). * @param {*} value - The value to assign. * @param {string=} separator - The separator (defaults to a period character). */ export function write(target: object, propertyNames: string | string[], value: any, separator?: string | undefined): void; /** * Erases a property from the target object. * * @public * @static * @param {object} target - The object to erase a property from. * @param {string|string} propertyNames - The property to write -- either a string with separators, or an array of strings (already split by separator). * @param {string=} separator - The separator (defaults to a period character). */ export function erase(target: object, propertyNames: string | string, separator?: string | undefined): void;