Search documentation

Search by topic, API name, or import path.

GitHub ↗

Module / v2.0.0-beta.7

@typed/fx/RefArray

31 unique exports available through this public import path, including their members and aliases.

import * as RefArray from "@typed/fx/RefArray";

Constructors

  • make

    function

    Creates a new RefArray from an array, Effect, or Fx.

Derived queries

  • filterValues

    variable

    Filter the values of a RefArray using a predicate creating a Computed value.

  • groupBy

    variable

    Group the values of a RefArray by a key.

  • length

    variable

    Get the current length of a RefArray.

  • mapValues

    variable

    Map the values with their indexes of a RefArray.

  • partition

    variable

    Partition the values of a RefArray using a predicate.

  • reduce

    variable

    Reduce the values of a RefArray to a single value.

  • reduceRight

    variable

    Reduce the values of a RefArray to a single value in reverse order.

Optional queries

  • getIndex

    variable

    Get a value contained a particular index of a RefArray.

  • head

    variable

    Gets the first element of a RefArray as a Filtered.

  • last

    variable

    Gets the last element of a RefArray as a Filtered.

State models

  • RefArray

    interface

    A RefArray is a RefSubject that is specialized over an array of values.

State predicates

  • isEmpty

    variable

    Check to see if a RefArray is empty.

  • isNonEmpty

    variable

    Check to see if a RefArray is non-empty.

State updates

  • append

    variable

    Append a value to the current state of a RefArray.

  • appendAll

    variable

    Append an iterable of values to the current state of a RefArray.

  • dedupeWith

    variable

    Remove any duplicate values from a RefArray.

  • drop

    variable

    Drop the first n values from a RefArray.

  • dropRight

    variable

    Drop the last n values from a RefArray.

  • dropWhile

    variable

    Drop values from a RefArray while a predicate is true.

  • insertAt

    variable

    Insert a value at a particular index of a RefArray.

  • map

    variable

    Map (Endomorphic) the values of a RefArray.

  • modifyAt

    variable

    Modify the value at a particular index of a RefArray.

  • prepend

    variable

    Prepend a value to the current state of a RefArray.

  • prependAll

    variable

    Prepend an iterable of values to the current state of a RefArray.

  • replaceAt

    variable

    Replace a value at a particular index of a RefArray.

  • rotate

    variable

    Rotate the values of a RefArray by n places. Helpful for things like carousels.

  • sortBy

    variable

    Sort the values of a RefArray using a provided Order.

  • take

    variable

    Take the first n values from a RefArray.

  • takeRight

    variable

    Take the last n values from a RefArray.

  • takeWhile

    variable

    Take values from a RefArray while a predicate is true.