Skip to main content Link Search Menu Expand Document (external link)
effect

MutableRef.ts overview

Since v2.0.0

Exports Grouped by Category

boolean

toggle

Signature

declare const toggle: (self: MutableRef<boolean>) => MutableRef<boolean>

Source

Since v2.0.0

constructors

make

Signature

declare const make: <T>(value: T) => MutableRef<T>

Source

Since v2.0.0

general

compareAndSet

Signature

declare const compareAndSet: {
  <T>(oldValue: T, newValue: T): (self: MutableRef<T>) => boolean
  <T>(self: MutableRef<T>, oldValue: T, newValue: T): boolean
}

Source

Since v2.0.0

get

Signature

declare const get: <T>(self: MutableRef<T>) => T

Source

Since v2.0.0

getAndSet

Signature

declare const getAndSet: { <T>(value: T): (self: MutableRef<T>) => T; <T>(self: MutableRef<T>, value: T): T }

Source

Since v2.0.0

getAndUpdate

Signature

declare const getAndUpdate: {
  <T>(f: (value: T) => T): (self: MutableRef<T>) => T
  <T>(self: MutableRef<T>, f: (value: T) => T): T
}

Source

Since v2.0.0

set

Signature

declare const set: {
  <T>(value: T): (self: MutableRef<T>) => MutableRef<T>
  <T>(self: MutableRef<T>, value: T): MutableRef<T>
}

Source

Since v2.0.0

setAndGet

Signature

declare const setAndGet: { <T>(value: T): (self: MutableRef<T>) => T; <T>(self: MutableRef<T>, value: T): T }

Source

Since v2.0.0

update

Signature

declare const update: {
  <T>(f: (value: T) => T): (self: MutableRef<T>) => MutableRef<T>
  <T>(self: MutableRef<T>, f: (value: T) => T): MutableRef<T>
}

Source

Since v2.0.0

updateAndGet

Signature

declare const updateAndGet: {
  <T>(f: (value: T) => T): (self: MutableRef<T>) => T
  <T>(self: MutableRef<T>, f: (value: T) => T): T
}

Source

Since v2.0.0

models

MutableRef (interface)

Signature

export interface MutableRef<out T> extends Pipeable, Inspectable {
  readonly [TypeId]: TypeId
  current: T
}

Source

Since v2.0.0

numeric

decrement

Signature

declare const decrement: (self: MutableRef<number>) => MutableRef<number>

Source

Since v2.0.0

decrementAndGet

Signature

declare const decrementAndGet: (self: MutableRef<number>) => number

Source

Since v2.0.0

getAndDecrement

Signature

declare const getAndDecrement: (self: MutableRef<number>) => number

Source

Since v2.0.0

getAndIncrement

Signature

declare const getAndIncrement: (self: MutableRef<number>) => number

Source

Since v2.0.0

increment

Signature

declare const increment: (self: MutableRef<number>) => MutableRef<number>

Source

Since v2.0.0

incrementAndGet

Signature

declare const incrementAndGet: (self: MutableRef<number>) => number

Source

Since v2.0.0

symbol

TypeId (type alias)

Signature

type TypeId = typeof TypeId

Source

Since v2.0.0