@univerjs/core v0.5.0-beta.1 • Docs

Function: get()

get(object, path)

function get<TObject, TKey>(object, path): TObject[TKey]

Gets the property value at path of object. If the resolved value is undefined the defaultValue is used in its place.

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type	Description
`object`	`TObject`	The object to query.
`path`	`TKey` \| [`TKey`]	The path of the property to get.

Returns

TObject[TKey]

Returns the resolved value.

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1127

get(object, path)

function get<TObject, TKey>(object, path): undefined | TObject[TKey]

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `TObject`
`path`	`TKey` \| [`TKey`]

Returns

undefined | TObject[TKey]

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1131

get(object, path, defaultValue)

function get<TObject, TKey, TDefault>(
   object, 
   path, 
defaultValue): TDefault | Exclude<TObject[TKey], undefined>

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey` extends `string` \| `number` \| `symbol`
`TDefault`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `TObject`
`path`	`TKey` \| [`TKey`]
`defaultValue`	`TDefault`

Returns

TDefault | Exclude<TObject[TKey], undefined>

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1135

get(object, path)

function get<TObject, TKey1, TKey2>(object, path): TObject[TKey1][TKey2]

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`object`	`TObject`
`path`	[`TKey1`, `TKey2`]

Returns

TObject[TKey1][TKey2]

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1139

get(object, path)

function get<TObject, TKey1, TKey2>(object, path): undefined | NonNullable<TObject[TKey1]>[TKey2]

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `TObject`
`path`	[`TKey1`, `TKey2`]

Returns

undefined | NonNullable<TObject[TKey1]>[TKey2]

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1143

get(object, path, defaultValue)

function get<TObject, TKey1, TKey2, TDefault>(
   object, 
   path, 
defaultValue): TDefault | Exclude<NonNullable<TObject[TKey1]>[TKey2], undefined>

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`
`TDefault`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `TObject`
`path`	[`TKey1`, `TKey2`]
`defaultValue`	`TDefault`

Returns

TDefault | Exclude<NonNullable<TObject[TKey1]>[TKey2], undefined>

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1147

get(object, path)

function get<TObject, TKey1, TKey2, TKey3>(object, path): TObject[TKey1][TKey2][TKey3]

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`
`TKey3` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`object`	`TObject`
`path`	[`TKey1`, `TKey2`, `TKey3`]

Returns

TObject[TKey1][TKey2][TKey3]

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1151

get(object, path)

function get<TObject, TKey1, TKey2, TKey3>(object, path): undefined | NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`
`TKey3` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `TObject`
`path`	[`TKey1`, `TKey2`, `TKey3`]

Returns

undefined | NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1155

get(object, path, defaultValue)

function get<TObject, TKey1, TKey2, TKey3, TDefault>(
   object, 
   path, 
defaultValue): TDefault | Exclude<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3], undefined>

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`
`TKey3` extends `string` \| `number` \| `symbol`
`TDefault`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `TObject`
`path`	[`TKey1`, `TKey2`, `TKey3`]
`defaultValue`	`TDefault`

Returns

TDefault | Exclude<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3], undefined>

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1159

get(object, path)

function get<TObject, TKey1, TKey2, TKey3, TKey4>(object, path): TObject[TKey1][TKey2][TKey3][TKey4]

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`
`TKey3` extends `string` \| `number` \| `symbol`
`TKey4` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`object`	`TObject`
`path`	[`TKey1`, `TKey2`, `TKey3`, `TKey4`]

Returns

TObject[TKey1][TKey2][TKey3][TKey4]

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1163

get(object, path)

function get<TObject, TKey1, TKey2, TKey3, TKey4>(object, path): undefined | NonNullable<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]>[TKey4]

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`
`TKey3` extends `string` \| `number` \| `symbol`
`TKey4` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `TObject`
`path`	[`TKey1`, `TKey2`, `TKey3`, `TKey4`]

Returns

undefined | NonNullable<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]>[TKey4]

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1167

get(object, path, defaultValue)

function get<TObject, TKey1, TKey2, TKey3, TKey4, TDefault>(
   object, 
   path, 
defaultValue): TDefault | Exclude<NonNullable<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]>[TKey4], undefined>

Type Parameters

Type Parameter
`TObject` extends `object`
`TKey1` extends `string` \| `number` \| `symbol`
`TKey2` extends `string` \| `number` \| `symbol`
`TKey3` extends `string` \| `number` \| `symbol`
`TKey4` extends `string` \| `number` \| `symbol`
`TDefault`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `TObject`
`path`	[`TKey1`, `TKey2`, `TKey3`, `TKey4`]
`defaultValue`	`TDefault`

Returns

TDefault | Exclude<NonNullable<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]>[TKey4], undefined>

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1171

get(object, path)

function get<T>(object, path): T

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type
`object`	`NumericDictionary`<`T`>
`path`	`number`

Returns

T

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1175

get(object, path)

function get<T>(object, path): undefined | T

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `NumericDictionary`<`T`>
`path`	`number`

Returns

undefined | T

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1179

get(object, path, defaultValue)

function get<T, TDefault>(
   object, 
   path, 
   defaultValue): T | TDefault

Type Parameters

Type Parameter
`T`
`TDefault`

Parameters

Parameter	Type
`object`	`undefined` \| `null` \| `NumericDictionary`<`T`>
`path`	`number`
`defaultValue`	`TDefault`

Returns

T | TDefault

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1183

get(object, path, defaultValue)

function get<TDefault>(
   object, 
   path, 
   defaultValue): TDefault

Type Parameters

Type Parameter
`TDefault`

Parameters

Parameter	Type
`object`	`undefined` \| `null`
`path`	`PropertyPath`
`defaultValue`	`TDefault`

Returns

TDefault

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1187

get(object, path)

function get(object, path): undefined

Parameters

Parameter	Type
`object`	`undefined` \| `null`
`path`	`PropertyPath`

Returns

undefined

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1191

get(data, path)

function get<TObject, TPath>(data, path): string extends TPath ? any : GetFieldType<TObject, TPath, "Path">

Type Parameters

Type Parameter
`TObject`
`TPath` extends `string`

Parameters

Parameter	Type
`data`	`TObject`
`path`	`TPath`

Returns

string extends TPath ? any : GetFieldType<TObject, TPath, "Path">

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1195

get(data, path, defaultValue)

function get<TObject, TPath, TDefault>(
   data, 
   path, 
defaultValue): TDefault | Exclude<GetFieldType<TObject, TPath, "Path">, undefined | null>

Type Parameters

Type Parameter	Default type
`TObject`	-
`TPath` extends `string`	-
`TDefault`	`GetFieldType`<`TObject`, `TPath`, `"Path"`>

Parameters

Parameter	Type
`data`	`TObject`
`path`	`TPath`
`defaultValue`	`TDefault`

Returns

TDefault | Exclude<GetFieldType<TObject, TPath, "Path">, undefined | null>

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1199

get(object, path, defaultValue)

function get(
   object, 
   path, 
   defaultValue?): any

Parameters

Parameter	Type
`object`	`any`
`path`	`PropertyPath`
`defaultValue`?	`any`

Returns

any

See

_.get

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/@types+lodash@4.17.13/node_modules/@types/lodash/common/object.d.ts:1203

Generaterandomid Getarraylength