gossamer - v7.0.0

gossamer/promise

Types

Promise

</> 
pub type Promise(a)

PromiseSettledResult

</> 
pub type PromiseSettledResult(a) {
  Fulfilled(value: a)
  Rejected(reason: dynamic.Dynamic)
}

Constructors

PromiseWithResolvers

</> 
pub type PromiseWithResolvers(a, r) {
  PromiseWithResolvers(
    promise: Promise(Result(a, String)),
    resolve: fn(a) -> Nil,
    reject: fn(r) -> Nil,
  )
}

Constructors 

  • PromiseWithResolvers(
  promise: Promise(Result(a, String)),
  resolve: fn(a) -> Nil,
  reject: fn(r) -> Nil,
)

Values

all

</> 
pub fn all(
  values: List(Promise(a)),
) -> Promise(Result(List(a), String))

Resolves with a list of results when all provided promises resolve, or rejects when any promise is rejected.

all_settled

</> 
pub fn all_settled(
  values: List(Promise(a)),
) -> Promise(List(PromiseSettledResult(a)))

Resolves with a list of PromiseSettledResults when all provided promises have settled (resolved or rejected), never short-circuiting on rejection.

any

</> 
pub fn any(
  values: List(Promise(a)),
) -> Promise(Result(a, String))

Resolves with the first fulfilled promise’s value. Rejects with an AggregateError only if all provided promises are rejected.

catch

</> 
pub fn catch(
  promise: Promise(a),
  apply onrejected: fn(dynamic.Dynamic) -> a,
) -> Promise(a)

finally

</> 
pub fn finally(
  promise: Promise(a),
  run onfinally: fn() -> b,
) -> Promise(a)

from_option

</> 
pub fn from_option(option: option.Option(a)) -> Promise(a)

from_result

</> 
pub fn from_result(result: Result(a, r)) -> Promise(a)

new

</> 
pub fn new(
  executor: fn(fn(a) -> b, fn(r) -> c) -> d,
) -> Promise(Result(a, String))

race

</> 
pub fn race(
  values: List(Promise(a)),
) -> Promise(Result(a, String))

Resolves or rejects as soon as any of the provided promises resolves or rejects, taking on that promise’s value.

reject

</> 
pub fn reject(reason: r) -> Promise(a)

resolve

</> 
pub fn resolve(value: a) -> Promise(a)

then

</> 
pub fn then(
  promise: Promise(a),
  apply onfulfilled: fn(a) -> b,
) -> Promise(b)

try

</> 
pub fn try(func: fn() -> a) -> Promise(Result(a, String))

with_resolvers

</> 
pub fn with_resolvers() -> PromiseWithResolvers(a, r)
✨ Search Document