@univerjscorefunctionsGet

@univerjs/core v0.5.4


Function: get()

Call Signature

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

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

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

ParameterTypeDescription
objectTObjectThe object to query.
pathTKey | [TKey]The path of the property to get.

Returns

TObject[TKey]

Returns the resolved value.

Call Signature

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

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

Type Parameters

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

Parameters

ParameterType
objectundefined | null | TObject
pathTKey | [TKey]

Returns

undefined | TObject[TKey]

See

_.get

Call Signature

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

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

Type Parameters

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

Parameters

ParameterType
objectundefined | null | TObject
pathTKey | [TKey]
defaultValueTDefault

Returns

TDefault | Exclude<TObject[TKey], undefined>

See

_.get

Call Signature

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

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

Type Parameters

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

Parameters

ParameterType
objectTObject
path[TKey1, TKey2]

Returns

TObject[TKey1][TKey2]

See

_.get

Call Signature

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

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

Type Parameters

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

Parameters

ParameterType
objectundefined | null | TObject
path[TKey1, TKey2]

Returns

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

See

_.get

Call Signature

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

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

Type Parameters

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

Parameters

ParameterType
objectundefined | null | TObject
path[TKey1, TKey2]
defaultValueTDefault

Returns

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

See

_.get

Call Signature

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

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

Type Parameters

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

Parameters

ParameterType
objectTObject
path[TKey1, TKey2, TKey3]

Returns

TObject[TKey1][TKey2][TKey3]

See

_.get

Call Signature

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

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

Type Parameters

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

Parameters

ParameterType
objectundefined | null | TObject
path[TKey1, TKey2, TKey3]

Returns

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

See

_.get

Call Signature

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

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

Type Parameters

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

Parameters

ParameterType
objectundefined | null | TObject
path[TKey1, TKey2, TKey3]
defaultValueTDefault

Returns

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

See

_.get

Call Signature

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

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

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

ParameterType
objectTObject
path[TKey1, TKey2, TKey3, TKey4]

Returns

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

See

_.get

Call Signature

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

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

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

ParameterType
objectundefined | null | TObject
path[TKey1, TKey2, TKey3, TKey4]

Returns

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

See

_.get

Call Signature

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

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

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

ParameterType
objectundefined | null | TObject
path[TKey1, TKey2, TKey3, TKey4]
defaultValueTDefault

Returns

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

See

_.get

Call Signature

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

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

Type Parameters

Type Parameter
T

Parameters

ParameterType
objectNumericDictionary<T>
pathnumber

Returns

T

See

_.get

Call Signature

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

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

Type Parameters

Type Parameter
T

Parameters

ParameterType
objectundefined | null | NumericDictionary<T>
pathnumber

Returns

undefined | T

See

_.get

Call Signature

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

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

Type Parameters

Type Parameter
T
TDefault

Parameters

ParameterType
objectundefined | null | NumericDictionary<T>
pathnumber
defaultValueTDefault

Returns

T | TDefault

See

_.get

Call Signature

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

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

Type Parameters

Type Parameter
TDefault

Parameters

ParameterType
objectundefined | null
pathPropertyPath
defaultValueTDefault

Returns

TDefault

See

_.get

Call Signature

function get(object, path): undefined

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

Parameters

ParameterType
objectundefined | null
pathPropertyPath

Returns

undefined

See

_.get

Call Signature

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

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

Type Parameters

Type Parameter
TObject
TPath extends string

Parameters

ParameterType
dataTObject
pathTPath

Returns

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

See

_.get

Call Signature

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

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

Type Parameters

Type ParameterDefault type
TObject-
TPath extends string-
TDefaultGetFieldType<TObject, TPath, "Path">

Parameters

ParameterType
dataTObject
pathTPath
defaultValueTDefault

Returns

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

See

_.get

Call Signature

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

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

Parameters

ParameterType
objectany
pathPropertyPath
defaultValue?any

Returns

any

See

_.get