main | rativ

Type Aliases

AnyFunc

AnyFunc: ((...args: any[]) => any)

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

Atom

Atom<T>: GetFn<T> & { error: any; get: GetFn<T>; key: string | undefined; loading: boolean; state: T; task: Promise<T> | undefined; abort: any; on: any; reset: any; snapshot: any }

Type Parameters

T = any

AtomErrorEvent

AtomErrorEvent: { error: any; rollback: any }

Type declaration

error: any
rollback:function
- rollback(): void
- - Defined in packages/rativ/lib/util/types.ts:14
  Returns void

AtomExtraProps

AtomExtraProps<THelpers>: { [ key in keyof THelpers]: THelpers[key] extends ((context: any, ...args: infer A) => infer R) ? ((...args: A) => R) : never }

Type Parameters

THelpers = {}

AtomFamily

AtomFamily<A, T>: { clear: any; delete: any; forEach: any; get: any; has: any } & (T extends UpdatableAtom<infer V> ? { set: SetFn<V> } : {})

Type Parameters

A extends any[]
T

AtomHelpers

AtomHelpers<T>: {}

Type Parameters

Type declaration

[key: string]: ((context: T, ...args: any[]) => any)
- - (context: T, ...args: any[]): any
  - Parameters
    - context: T
    - Rest ...args: any[]
    Returns any

AtomOptions

AtomOptions: { key?: string; onChange?: VoidFunction; onLoading?: VoidFunction; load?: any; onError?: any; save?: any }

Type declaration

Optional key?: string

name of atom, for debugging purpose
Optional onChange?: VoidFunction
Optional onLoading?: VoidFunction
load?:function
- load(): undefined | { state: any }
- - Defined in packages/rativ/lib/util/types.ts:197
  this function will be called when initializing atom
  
  Returns undefined | { state: any }
onError?:function
- onError(error: any): void
- - Defined in packages/rativ/lib/util/types.ts:203
  Parameters
  - error: any
  Returns void
save?:function
- save(state: any): void
- - Defined in packages/rativ/lib/util/types.ts:201
  this function will be called when atom state changed
  
  Parameters
  - state: any
  Returns void

Awaiter

Awaiter<T>: { $$type: "awaiter"; promise: Promise<T> }

Type Parameters

Type declaration

$$type: "awaiter"
promise: Promise<T>

CompareFn

CompareFn<T>: ((a: T, b: T) => boolean)

Type Parameters

T = any

Type declaration

- (a: T, b: T): boolean
- Parameters
  - a: T
  - b: T
  Returns boolean

ComputedAtom

ComputedAtom<T>: UpdatableAtom<T>

Type Parameters

Context

Context: { aborted: boolean; signal: AbortController["signal"] | undefined; abort: any }

Type declaration

Readonly aborted: boolean

is aborted
Readonly signal: AbortController["signal"] | undefined

AbortController signal
abort:function
- abort(): void
- - Defined in packages/rativ/lib/util/types.ts:149
  abort the context
  
  Returns void

CreateAtom

CreateAtom: { (): UpdatableAtom<void>; <T>(computeFn: ((context: Context) => T | Awaiter<T>), options?: AtomOptions): ComputedAtom<T>; <T, H>(computeFn: ((context: Context) => T | Awaiter<T>), options: AtomOptions & { helpers: H }): GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>; <T>(initialState: T | Promise<T>, options?: AtomOptions): UpdatableAtom<T>; <T, H>(initialState: T | Promise<T>, options: AtomOptions & { helpers: H }): GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>; <T, A>(initialState: T, reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>), options?: EmittableOptions<A>): EmittableAtom<T, A>; <T, H, A>(initialState: T, reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>), options: AtomOptions & { initAction?: A; onEmit?: any } & { helpers: H }): GetFn<T> & { error: any; get: GetFn<T>; key: string | undefined; loading: boolean; state: T; task: Promise<T> | undefined; abort: any; on: any; reset: any; snapshot: any } & { emit: EmitFn<T, A>; cancel: any; on: any } & AtomExtraProps<H> }

Type declaration

- (): UpdatableAtom<void>
- <T>(computeFn: ((context: Context) => T | Awaiter<T>), options?: AtomOptions): ComputedAtom<T>
- <T, H>(computeFn: ((context: Context) => T | Awaiter<T>), options: AtomOptions & { helpers: H }): GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>
- <T>(initialState: T | Promise<T>, options?: AtomOptions): UpdatableAtom<T>
- <T, H>(initialState: T | Promise<T>, options: AtomOptions & { helpers: H }): GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>
- <T, A>(initialState: T, reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>), options?: EmittableOptions<A>): EmittableAtom<T, A>
- <T, H, A>(initialState: T, reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>), options: AtomOptions & { initAction?: A; onEmit?: any } & { helpers: H }): GetFn<T> & { error: any; get: GetFn<T>; key: string | undefined; loading: boolean; state: T; task: Promise<T> | undefined; abort: any; on: any; reset: any; snapshot: any } & { emit: EmitFn<T, A>; cancel: any; on: any } & AtomExtraProps<H>
- Returns UpdatableAtom<void>
- create computed atom
  
  Type Parameters
  - T
  Parameters
  - computeFn: ((context: Context) => T | Awaiter<T>)
    - - (context: Context): T | Awaiter<T>
      - Parameters
        context: Context
        Returns T | Awaiter<T>
  - Optional options: AtomOptions
  Returns ComputedAtom<T>
- Type Parameters
  - T
  - H extends AtomHelpers<[GetFn<T>, SetFn<T>]>
  Parameters
  - computeFn: ((context: Context) => T | Awaiter<T>)
    - - (context: Context): T | Awaiter<T>
      - Parameters
        context: Context
        Returns T | Awaiter<T>
  - options: AtomOptions & { helpers: H }
  Returns GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>
- create updatable atom
  
  Type Parameters
  - T
  Parameters
  - initialState: T | Promise<T>
  - Optional options: AtomOptions
  Returns UpdatableAtom<T>
- Type Parameters
  - T
  - H extends AtomHelpers<[GetFn<T>, SetFn<T>]>
  Parameters
  - initialState: T | Promise<T>
  - options: AtomOptions & { helpers: H }
  Returns GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>
- create amittable atom
  
  Type Parameters
  - T
  - A = void
  Parameters
  - initialState: T
  - reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>)
    - - (state: NoInfer<T>, action: A, context: Context): T | Awaiter<T>
      - Parameters
        state: NoInfer<T>
        action: A
        context: Context
        Returns T | Awaiter<T>
  - Optional options: EmittableOptions<A>
  Returns EmittableAtom<T, A>
- Type Parameters
  - T
  - H extends AtomHelpers<[GetFn<T>, EmitFn<T, A>]>
  - A = void
  Parameters
  - initialState: T
  - reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>)
    - - (state: NoInfer<T>, action: A, context: Context): T | Awaiter<T>
      - Parameters
        state: NoInfer<T>
        action: A
        context: Context
        Returns T | Awaiter<T>
  - options: AtomOptions & { initAction?: A; onEmit?: any } & { helpers: H }
  Returns GetFn<T> & { error: any; get: GetFn<T>; key: string | undefined; loading: boolean; state: T; task: Promise<T> | undefined; abort: any; on: any; reset: any; snapshot: any } & { emit: EmitFn<T, A>; cancel: any; on: any } & AtomExtraProps<H>

CreateSnapshot

CreateSnapshot: { (atoms: Atom<any>[], reset?: boolean): VoidFunction; <T>(atoms: Atom<any>[], callback: (() => T)): T; <T>(atoms: Atom<any>[], reset: boolean, callback: (() => T)): T }

Type declaration

- (atoms: Atom<any>[], reset?: boolean): VoidFunction
- <T>(atoms: Atom<any>[], callback: (() => T)): T
- <T>(atoms: Atom<any>[], reset: boolean, callback: (() => T)): T
- Parameters
  - atoms: Atom<any>[]
  - Optional reset: boolean
  Returns VoidFunction
- Type Parameters
  - T
  Parameters
  - atoms: Atom<any>[]
  - callback: (() => T)
    - - (): T
      - Returns T
  Returns T
- Type Parameters
  - T
  Parameters
  - atoms: Atom<any>[]
  - reset: boolean
  - callback: (() => T)
    - - (): T
      - Returns T
  Returns T

EmitFn

EmitFn<T, A>: ((action: A) => EmittableAtom<T, A>)

Type Parameters

Type declaration

- (action: A): EmittableAtom<T, A>
- emit an action and atom reducer will handle the action
  
  Parameters
  - action: A
  Returns EmittableAtom<T, A>

EmittableAtom

EmittableAtom<T, A>: Atom<T> & { emit: EmitFn<T, A>; cancel: any; on: any }

Type Parameters

T = any
A = void

EmittableOptions

EmittableOptions<A>: AtomOptions & { initAction?: A; onEmit?: any }

Type Parameters

A = any

GetFn

GetFn<T>: { (): T; <R>(selector: ((state: T) => R)): R; <K>(path: K): PathValue<T, K> }

Type Parameters

Type declaration

- (): T
- <R>(selector: ((state: T) => R)): R
- <K>(path: K): PathValue<T, K>
- get current state of the atom
  
  Returns T
- get result of the selector, the selector retrieves current state of the atom
  
  Type Parameters
  - R
  Parameters
  - selector: ((state: T) => R)
    - - (state: T): R
      - Parameters
        state: T
        Returns R
  Returns R
- Type Parameters
  - K extends string
  Parameters
  - path: K
  Returns PathValue<T, K>

KeyOf

KeyOf: { <T, E>(obj: T, exclude: E[]): Exclude<keyof T, E>[]; <T>(obj: T): (keyof T)[] }

Type declaration

- <T, E>(obj: T, exclude: E[]): Exclude<keyof T, E>[]
- <T>(obj: T): (keyof T)[]
- Type Parameters
  - T
  - E extends string | number | symbol
  Parameters
  - obj: T
  - exclude: E[]
  Returns Exclude<keyof T, E>[]
- Type Parameters
  - T
  Parameters
  - obj: T
  Returns (keyof T)[]

Listener

Listener<T, A>: ((e: T, a: A) => void)

Type Parameters

T
A = void

Type declaration

- (e: T, a: A): void
- Parameters
  - e: T
  - a: A
  Returns void

Mutation

Mutation<T, R>: ((prev: T) => R)

Type Parameters

T
R = T

Type declaration

- (prev: T): R
- Parameters
  - prev: T
  Returns R

NoInfer

NoInfer<T>: [T][T extends any ? 0 : never]

Type Parameters

Nullable

Nullable<T>: T | undefined | null

Type Parameters

Rearg

Rearg: { (func: Function, indexes: number[]): ((...args: any[]) => any); (func: Function, skip: number): ((...args: any[]) => any) }

Type declaration

- (func: Function, indexes: number[]): ((...args: any[]) => any)
- (func: Function, skip: number): ((...args: any[]) => any)
- Creates a function that invokes func with arguments arranged according to the specified indexes where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.
  
  Parameters
  - func: Function
  - indexes: number[]
  Returns ((...args: any[]) => any)
  - - (...args: any[]): any
    - Creates a function that invokes func with arguments arranged according to the specified indexes where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.
      
      Parameters
      - Rest ...args: any[]
      Returns any
- Creates a function that invokes func with arguments that are selected from input arguments after skipped N arguments.
  
  Parameters
  - func: Function
  - skip: number
  Returns ((...args: any[]) => any)
  - - (...args: any[]): any
    - Creates a function that invokes func with arguments that are selected from input arguments after skipped N arguments.
      
      Parameters
      - Rest ...args: any[]
      Returns any

SetFn

SetFn<T>: { (mutation: Mutation<T, T>, ...mutations: Mutation<T, T>[]): VoidFunction; (state: T | ((prev: T, context: Context) => T | Promise<T> | Awaiter<T>) | Promise<T> | Awaiter<T>): VoidFunction }

Type Parameters

Type declaration

- (mutation: Mutation<T, T>, ...mutations: Mutation<T, T>[]): VoidFunction
- (state: T | ((prev: T, context: Context) => T | Promise<T> | Awaiter<T>) | Promise<T> | Awaiter<T>): VoidFunction
- update current state of the atom by using specfied mutations
  
  Parameters
  - mutation: Mutation<T, T>
  - Rest ...mutations: Mutation<T, T>[]
  Returns VoidFunction
- update current state of the atom
  
  Parameters
  - state: T | ((prev: T, context: Context) => T | Promise<T> | Awaiter<T>) | Promise<T> | Awaiter<T>
  Returns VoidFunction

Task

Task<T, A>: { aborted: boolean; abort: any; runner: any }

Type Parameters

T
A extends any[]

Type declaration

- (...args: A): T
- Parameters
  - Rest ...args: A
  Returns T
Readonly aborted: boolean
abort:function
- abort(): void
- - Defined in packages/rativ/lib/main.ts:105
  Returns void
runner:function
- runner(...args: A): (() => T)
- - Defined in packages/rativ/lib/main.ts:106
  Parameters
  - Rest ...args: A
  Returns (() => T)
  - - (): T
    - Returns T

UpdatableAtom

UpdatableAtom<T>: GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any }

Type Parameters

T = any

Wait

Wait: { <A>(awaitable: Atom<A> | Awaitable<A> | Promise<A>): Awaiter<A>; <A, T, P>(awaitable: Atom<A> | Awaitable<A> | Promise<A>, fn: ((value: A, ...args: P) => T | Awaiter<T>), ...args: P): T extends Promise<any> ? never : Awaiter<T>; <A, T, P>(awaitables: A, fn: ((values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }, ...args: P) => T | Awaiter<T>), ...args: P): T extends Promise<any> ? never : Awaiter<T> }

Type declaration

- <A>(awaitable: Atom<A> | Awaitable<A> | Promise<A>): Awaiter<A>
- <A, T, P>(awaitable: Atom<A> | Awaitable<A> | Promise<A>, fn: ((value: A, ...args: P) => T | Awaiter<T>), ...args: P): T extends Promise<any> ? never : Awaiter<T>
- <A, T, P>(awaitables: A, fn: ((values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }, ...args: P) => T | Awaiter<T>), ...args: P): T extends Promise<any> ? never : Awaiter<T>
- Type Parameters
  - A
  Parameters
  - awaitable: Atom<A> | Awaitable<A> | Promise<A>
  Returns Awaiter<A>
- Type Parameters
  - A
  - T
  - P extends any[]
  Parameters
  - awaitable: Atom<A> | Awaitable<A> | Promise<A>
  - fn: ((value: A, ...args: P) => T | Awaiter<T>)
    - - (value: A, ...args: P): T | Awaiter<T>
      - Parameters
        value: A
        Rest ...args: P
        Returns T | Awaiter<T>
  - Rest ...args: P
  Returns T extends Promise<any> ? never : Awaiter<T>
- Type Parameters
  - A extends {}
  - T
  - P extends any[]
  Parameters
  - awaitables: A
  - fn: ((values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }, ...args: P) => T | Awaiter<T>)
    - - (values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }, ...args: P): T | Awaiter<T>
      - Parameters
        values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }
        Rest ...args: P
        Returns T | Awaiter<T>
  - Rest ...args: P
  Returns T extends Promise<any> ? never : Awaiter<T>

Watch

Watch: { <T>(changeSelector: (() => T), callback: ((value: T) => void)): VoidFunction; <T>(changeSelector: (() => T), options: WatchOptions<T>): VoidFunction }

Type declaration

- <T>(changeSelector: (() => T), callback: ((value: T) => void)): VoidFunction
- <T>(changeSelector: (() => T), options: WatchOptions<T>): VoidFunction
- Type Parameters
  - T
  Parameters
  - changeSelector: (() => T)
    - - (): T
      - Returns T
  - callback: ((value: T) => void)
    - - (value: T): void
      - Parameters
        value: T
        Returns void
  Returns VoidFunction
- Type Parameters
  - T
  Parameters
  - changeSelector: (() => T)
    - - (): T
      - Returns T
  - options: WatchOptions<T>
  Returns VoidFunction

WatchOptions

WatchOptions<T>: { defer?: boolean; callback?: any; compare?: any }

Type Parameters

Type declaration

Optional defer?: boolean
callback?:function
- callback(value: T): any
- - Defined in packages/rativ/lib/main.ts:116
  Parameters
  - value: T
  Returns any
compare?:function
- compare(a: T, b: T): boolean
- - Defined in packages/rativ/lib/main.ts:117
  Parameters
  - a: T
  - b: T
  Returns boolean

Functions

atom

atom(): UpdatableAtom<void>
atom<T>(computeFn: ((context: Context) => T | Awaiter<T>), options?: AtomOptions): ComputedAtom<T>
atom<T, H>(computeFn: ((context: Context) => T | Awaiter<T>), options: AtomOptions & { helpers: H }): GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>
atom<T>(initialState: T | Promise<T>, options?: AtomOptions): UpdatableAtom<T>
atom<T, H>(initialState: T | Promise<T>, options: AtomOptions & { helpers: H }): GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>
atom<T, A>(initialState: T, reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>), options?: EmittableOptions<A>): EmittableAtom<T, A>
atom<T, H, A>(initialState: T, reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>), options: AtomOptions & { initAction?: A; onEmit?: any } & { helpers: H }): GetFn<T> & { error: any; get: GetFn<T>; key: undefined | string; loading: boolean; state: T; task: undefined | Promise<T>; abort: any; on: any; reset: any; snapshot: any } & { emit: EmitFn<T, A>; cancel: any; on: any } & AtomExtraProps<H>

- Defined in packages/rativ/lib/main.ts:122
Returns UpdatableAtom<void>
- Defined in packages/rativ/lib/main.ts:122
Type Parameters
- T
Parameters
- computeFn: ((context: Context) => T | Awaiter<T>)
  - - (context: Context): T | Awaiter<T>
    - Parameters
      - context: Context
      Returns T | Awaiter<T>
- Optional options: AtomOptions
Returns ComputedAtom<T>
- Defined in packages/rativ/lib/main.ts:122
Type Parameters
- T
- H extends AtomHelpers<[GetFn<T>, SetFn<T>]>
Parameters
- computeFn: ((context: Context) => T | Awaiter<T>)
  - - (context: Context): T | Awaiter<T>
    - Parameters
      - context: Context
      Returns T | Awaiter<T>
- options: AtomOptions & { helpers: H }
Returns GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>
- Defined in packages/rativ/lib/main.ts:122
Type Parameters
- T
Parameters
- initialState: T | Promise<T>
- Optional options: AtomOptions
Returns UpdatableAtom<T>
- Defined in packages/rativ/lib/main.ts:122
Type Parameters
- T
- H extends AtomHelpers<[GetFn<T>, SetFn<T>]>
Parameters
- initialState: T | Promise<T>
- options: AtomOptions & { helpers: H }
Returns GetFn<T> & Omit<Atom<T>, "state"> & { set: SetFn<T>; state: T; cancel: any; defer: any; mutate: any } & AtomExtraProps<H>
- Defined in packages/rativ/lib/main.ts:122
Type Parameters
- T
- A = void
Parameters
- initialState: T
- reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>)
  - - (state: NoInfer<T>, action: A, context: Context): T | Awaiter<T>
    - Parameters
      - state: NoInfer<T>
      - action: A
      - context: Context
      Returns T | Awaiter<T>
- Optional options: EmittableOptions<A>
Returns EmittableAtom<T, A>
- Defined in packages/rativ/lib/main.ts:122
Type Parameters
- T
- H extends AtomHelpers<[GetFn<T>, EmitFn<T, A>]>
- A = void
Parameters
- initialState: T
- reducer: ((state: NoInfer<T>, action: A, context: Context) => T | Awaiter<T>)
  - - (state: NoInfer<T>, action: A, context: Context): T | Awaiter<T>
    - Parameters
      - state: NoInfer<T>
      - action: A
      - context: Context
      Returns T | Awaiter<T>
- options: AtomOptions & { initAction?: A; onEmit?: any } & { helpers: H }
Returns GetFn<T> & { error: any; get: GetFn<T>; key: undefined | string; loading: boolean; state: T; task: undefined | Promise<T>; abort: any; on: any; reset: any; snapshot: any } & { emit: EmitFn<T, A>; cancel: any; on: any } & AtomExtraProps<H>

delay

delay<T>(ms?: number, value?: T): Promise<T> & { cancel: any }

- Defined in packages/rativ/lib/util/delay.ts:1
Type Parameters
- T
Parameters
- ms: number = 0
- Optional value: T
Returns Promise<T> & { cancel: any }

family

family<A, T>(createFn: ((...args: A) => T)): AtomFamily<A, T>

- Defined in packages/rativ/lib/main.ts:708
Type Parameters
- A extends any[]
- T = unknown
Parameters
- createFn: ((...args: A) => T)
  - - (...args: A): T
    - Parameters
      - Rest ...args: A
      Returns T
Returns AtomFamily<A, T>

isAtom

isAtom<T>(value: any): value is Atom<T>

- Defined in packages/rativ/lib/main.ts:611
determine the value is whether atom or not

Type Parameters
- T
Parameters
- value: any
Returns value is Atom<T>

keyOf

keyOf<T, E>(obj: T, exclude: E[]): Exclude<keyof T, E>[]
keyOf<T>(obj: T): (keyof T)[]

- Defined in packages/rativ/lib/main.ts:692
Type Parameters
- T
- E extends string | number | symbol
Parameters
- obj: T
- exclude: E[]
Returns Exclude<keyof T, E>[]
- Defined in packages/rativ/lib/main.ts:692
Type Parameters
- T
Parameters
- obj: T
Returns (keyof T)[]

rearg

rearg(func: Function, indexes: number[]): ((...args: any[]) => any)
rearg(func: Function, skip: number): ((...args: any[]) => any)

- Defined in packages/rativ/lib/main.ts:901
Parameters
- func: Function
- indexes: number[]
Returns ((...args: any[]) => any)
- - (...args: any[]): any
  - Creates a function that invokes func with arguments arranged according to the specified indexes where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.
    
    Parameters
    - Rest ...args: any[]
    Returns any
- Defined in packages/rativ/lib/main.ts:901
Parameters
- func: Function
- skip: number
Returns ((...args: any[]) => any)
- - (...args: any[]): any
  - Creates a function that invokes func with arguments that are selected from input arguments after skipped N arguments.
    
    Parameters
    - Rest ...args: any[]
    Returns any

snapshot

snapshot(atoms: Atom<any>[], reset?: boolean): VoidFunction
snapshot<T>(atoms: Atom<any>[], callback: (() => T)): T
snapshot<T>(atoms: Atom<any>[], reset: boolean, callback: (() => T)): T

- Defined in packages/rativ/lib/main.ts:667
Parameters
- atoms: Atom<any>[]
- Optional reset: boolean
Returns VoidFunction
- Defined in packages/rativ/lib/main.ts:667
Type Parameters
- T
Parameters
- atoms: Atom<any>[]
- callback: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in packages/rativ/lib/main.ts:667
Type Parameters
- T
Parameters
- atoms: Atom<any>[]
- reset: boolean
- callback: (() => T)
  - - (): T
    - Returns T
Returns T

throws

throws(error: string | Error): never

- Defined in packages/rativ/lib/main.ts:884
Parameters
- error: string | Error
Returns never

wait

wait<A>(awaitable: Atom<A> | Awaitable<A> | Promise<A>): Awaiter<A>
wait<A, T, P>(awaitable: Atom<A> | Awaitable<A> | Promise<A>, fn: ((value: A, ...args: P) => T | Awaiter<T>), ...args: P): T extends Promise<any> ? never : Awaiter<T>
wait<A, T, P>(awaitables: A, fn: ((values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }, ...args: P) => T | Awaiter<T>), ...args: P): T extends Promise<any> ? never : Awaiter<T>

- Defined in packages/rativ/lib/main.ts:794
Type Parameters
- A
Parameters
- awaitable: Atom<A> | Awaitable<A> | Promise<A>
Returns Awaiter<A>
- Defined in packages/rativ/lib/main.ts:794
Type Parameters
- A
- T
- P extends any[]
Parameters
- awaitable: Atom<A> | Awaitable<A> | Promise<A>
- fn: ((value: A, ...args: P) => T | Awaiter<T>)
  - - (value: A, ...args: P): T | Awaiter<T>
    - Parameters
      - value: A
      - Rest ...args: P
      Returns T | Awaiter<T>
- Rest ...args: P
Returns T extends Promise<any> ? never : Awaiter<T>
- Defined in packages/rativ/lib/main.ts:794
Type Parameters
- A extends {}
- T
- P extends any[]
Parameters
- awaitables: A
- fn: ((values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }, ...args: P) => T | Awaiter<T>)
  - - (values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }, ...args: P): T | Awaiter<T>
    - Parameters
      - values: { [ key in string | number | symbol]: A[key] extends Atom<V> ? V : A[key] extends Promise<V> ? V : never }
      - Rest ...args: P
      Returns T | Awaiter<T>
- Rest ...args: P
Returns T extends Promise<any> ? never : Awaiter<T>

watch

watch<T>(changeSelector: (() => T), callback: ((value: T) => void)): VoidFunction
watch<T>(changeSelector: (() => T), options: WatchOptions<T>): VoidFunction

- Defined in packages/rativ/lib/main.ts:615
Type Parameters
- T
Parameters
- changeSelector: (() => T)
  - - (): T
    - Returns T
- callback: ((value: T) => void)
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
Returns VoidFunction
- Defined in packages/rativ/lib/main.ts:615
Type Parameters
- T
Parameters
- changeSelector: (() => T)
  - - (): T
    - Returns T
- options: WatchOptions<T>
Returns VoidFunction

Index

Type Aliases

Functions

Type Aliases

AnyFunc

Type declaration

Parameters

Rest ...args: any[]

Returns any

Atom

Type Parameters

T = any

AtomErrorEvent

Type declaration

error: any

rollback:function

Returns void

AtomExtraProps

Type Parameters

THelpers = {}

AtomFamily

Type Parameters

A extends any[]

T

AtomHelpers

Type Parameters

T

Type declaration

[key: string]: ((context: T, ...args: any[]) => any)

Parameters

context: T

Rest ...args: any[]

Returns any

AtomOptions

Type declaration

Optional key?: string

Optional onChange?: VoidFunction

Optional onLoading?: VoidFunction

load?:function

Returns undefined | { state: any }

onError?:function

Parameters

error: any

Returns void

save?:function

Parameters

state: any

Returns void

Awaiter

Type Parameters

T

Type declaration

$$type: "awaiter"

promise: Promise<T>

CompareFn

Type Parameters

T = any

Type declaration

Parameters

a: T

b: T

Returns boolean

ComputedAtom

Type Parameters

T

Context

Type declaration

Readonly aborted: boolean

Readonly signal: AbortController["signal"] | undefined

abort:function

Returns void

CreateAtom

Type declaration

Returns UpdatableAtom<void>

Type Parameters

T

Parameters

computeFn: ((context: Context) => T | Awaiter<T>)

Parameters

context: Context