Skip to content

Commit

Permalink
feat: export immutibility type helpers in public API
Browse files Browse the repository at this point in the history
  • Loading branch information
Mohammad Hasani authored and the-dr-lazy committed Jun 15, 2019
1 parent 0f35d7f commit b723d35
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
20 changes: 20 additions & 0 deletions docs/api-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,23 @@ A type that creates Flux-standard compliant action.
## _ActionType<T\>_

A type that infers action from (**_ActionCreator_** ) or (**_Reducer_** ).

## _DeepImmutable<T\>_

A type which gives any type as input and return corresponding **deeply** immutable data structure as output.

## _DeepImmutableObject<T\>_

A type which gives an `object` type as input and return corresponding **deeply** immutable data structure as output.

## _DeepImmutableMap<T\>_

A type which gives a `Map` type as input and return corresponding **deeply** immutable data structure as output.

## _DeepImmutableArray<T\>_

A type which gives an `Array` type as input and return corresponding \*\*deeply immutable data structure as output.

## _Immutable<T\>_

A type which gives any type as input and return corresponding **shallowly** immutable data structure as output.
9 changes: 8 additions & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,11 @@ export {
export { getType } from './get-type'
export { createReducer } from './create-reducer'
export { ofType } from './of-type'
export { ActionType } from './types'
export {
ActionType,
Immutable,
DeepImmutable,
DeepImmutableArray,
DeepImmutableMap,
DeepImmutableObject,
} from './types'

0 comments on commit b723d35

Please sign in to comment.