Logo Xantham

KeyOf Module

Functions and values

Function or value Description

access

Full Usage: access

Returns: keyof<'a> -> 'a -> obj option
Type parameters: 'a

Alias for item

Returns: keyof<'a> -> 'a -> obj option

fromPropertyKey key

Full Usage: fromPropertyKey key

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

item key obj

Full Usage: item key obj

Parameters:
    key : keyof<'T>
    obj : 'T

Returns: obj option
Modifiers: inline
Type parameters: 'T
key : keyof<'T>
obj : 'T
Returns: obj option

tryUnbox func key

Full Usage: tryUnbox func key

Parameters:
    func : 'T -> 'ReturnType -
    key : keyof<'T> -

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

Unboxes the property key with the path of the given function.

func : 'T -> 'ReturnType

key : keyof<'T>

Returns: typekeyof<'T, 'ReturnType> option

unsafeUnbox key

Full Usage: unsafeUnbox key

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

value key

Full Usage: value key

Parameters:
Returns: string
Modifiers: inline
Type parameters: 'T
key : keyof<'T>
Returns: string

Type something to start searching.