Logo Xantham

TypeKeyOf Module

Functions and values

Function or value Description

access key obj

Full Usage: access key obj

Parameters:
Returns: 'ReturnType
Modifiers: inline
Type parameters: 'T, 'ReturnType

Alias for item; inline for the reason KeyOf.access is.

key : typekeyof<'T, 'ReturnType>
obj : 'T
Returns: 'ReturnType

box key

Full Usage: box key

Parameters:
Returns: keyof<'T>
Modifiers: inline
Type parameters: 'T, 'ReturnType
key : typekeyof<'T, 'ReturnType>
Returns: keyof<'T>

create path

Full Usage: create path

Parameters:
    path : 'T -> 'ReturnType

Returns: typekeyof<'T, 'ReturnType>
Modifiers: inline
Type parameters: 'T, 'ReturnType

Create a path key. You should not access nested properties directly.

path : 'T -> 'ReturnType
Returns: typekeyof<'T, 'ReturnType>

item key obj

Full Usage: item key obj

Parameters:
    key : typekeyof<'T, 'ReturnType> - The path key
    obj : 'T - Object being accessed

Returns: 'ReturnType
Modifiers: inline
Type parameters: 'T, 'ReturnType

Access a property of an object using a path.

key : typekeyof<'T, 'ReturnType>

The path key

obj : 'T

Object being accessed

Returns: 'ReturnType

value key

Full Usage: value key

Parameters:
Returns: string
Modifiers: inline
Type parameters: 'T, 'ReturnType
key : typekeyof<'T, 'ReturnType>
Returns: string

Type something to start searching.