Header menu logo issie

Map Module

Functions and values

Function or value Description

array_

Full Usage: array_

Returns: Isomorphism<Map<'k, 'v>, ('k * 'v)[]>

Weak Isomorphism to an array of key-value pairs.

Returns: Isomorphism<Map<'k, 'v>, ('k * 'v)[]>

key_ k

Full Usage: key_ k

Parameters:
    k : 'k

Returns: Prism<Map<'k, 'v>, 'v>
Modifiers: inline
Type parameters: 'k, 'v

Prism to a value associated with a key in a map.

k : 'k
Returns: Prism<Map<'k, 'v>, 'v>

list_

Full Usage: list_

Returns: Isomorphism<Map<'k, 'v>, ('k * 'v) list>

Weak Isomorphism to a list of key-value pairs.

Returns: Isomorphism<Map<'k, 'v>, ('k * 'v) list>

valueForce_ getFailErrorMessage k

Full Usage: valueForce_ getFailErrorMessage k

Parameters:
    getFailErrorMessage : string
    k : 'k

Returns: Lens<Map<'k, 'v>, 'v>
Modifiers: inline
Type parameters: 'k, 'v

Unsafe lens to a value associated with a key in a map. Use only when maps are known to be complete

getFailErrorMessage : string
k : 'k
Returns: Lens<Map<'k, 'v>, 'v>

valueWithDefault_ defaultVal k

Full Usage: valueWithDefault_ defaultVal k

Parameters:
    defaultVal : 'v
    k : 'k

Returns: Lens<Map<'k, 'v>, 'v>
Modifiers: inline
Type parameters: 'v, 'k

Safe lens to a value associated with a key in a map. If the key does not exist defaultVal is returned

defaultVal : 'v
k : 'k
Returns: Lens<Map<'k, 'v>, 'v>

value_ k

Full Usage: value_ k

Parameters:
    k : 'k

Returns: Lens<Map<'k, 'v>, 'v option>
Modifiers: inline
Type parameters: 'k, 'v

Lens to a value option associated with a key in a map.

k : 'k
Returns: Lens<Map<'k, 'v>, 'v option>

Type something to start searching.