Skip to content

Latest commit

 

History

History
399 lines (200 loc) · 7.04 KB

Combiner.md

File metadata and controls

399 lines (200 loc) · 7.04 KB

@vladbasin/ts-resultDocs


@vladbasin/ts-result / Combiner

Class: Combiner

Constructors

new Combiner()

new Combiner(): Combiner

Returns

Combiner

Methods

Combine2()

static Combine2<T1, T2>(r1, r2): Result<[T1, T2]>

Combines two Results into one.

Type Parameters

T1

T2

Parameters

r1: Result<T1>

First Result.

r2: Result<T2>

Second Result.

Returns

Result<[T1, T2]>

New Result storing an array with values from the two Results.

Defined in

src/Combiner.ts:12


Combine3()

static Combine3<T1, T2, T3>(r1, r2, r3): Result<[T1, T2, T3]>

Combines three Results into one.

Type Parameters

T1

T2

T3

Parameters

r1: Result<T1>

First Result.

r2: Result<T2>

Second Result.

r3: Result<T3>

Third Result.

Returns

Result<[T1, T2, T3]>

New Result storing an array with values from the three Results.

Defined in

src/Combiner.ts:23


Combine4()

static Combine4<T1, T2, T3, T4>(r1, r2, r3, r4): Result<[T1, T2, T3, T4]>

Combines four Results into one.

Type Parameters

T1

T2

T3

T4

Parameters

r1: Result<T1>

First Result.

r2: Result<T2>

Second Result.

r3: Result<T3>

Third Result.

r4: Result<T4>

Fourth Result.

Returns

Result<[T1, T2, T3, T4]>

New Result storing an array with values from the four Results.

Defined in

src/Combiner.ts:35


Combine5()

static Combine5<T1, T2, T3, T4, T5>(r1, r2, r3, r4, r5): Result<[T1, T2, T3, T4, T5]>

Combines five Results into one.

Type Parameters

T1

T2

T3

T4

T5

Parameters

r1: Result<T1>

First Result.

r2: Result<T2>

Second Result.

r3: Result<T3>

Third Result.

r4: Result<T4>

Fourth Result.

r5: Result<T5>

Fifth Result.

Returns

Result<[T1, T2, T3, T4, T5]>

New Result storing an array with values from the five Results.

Defined in

src/Combiner.ts:53


Combine6()

static Combine6<T1, T2, T3, T4, T5, T6>(r1, r2, r3, r4, r5, r6): Result<[T1, T2, T3, T4, T5, T6]>

Combines six Results into one.

Type Parameters

T1

T2

T3

T4

T5

T6

Parameters

r1: Result<T1>

First Result.

r2: Result<T2>

Second Result.

r3: Result<T3>

Third Result.

r4: Result<T4>

Fourth Result.

r5: Result<T5>

Fifth Result.

r6: Result<T6>

Sixth Result.

Returns

Result<[T1, T2, T3, T4, T5, T6]>

New Result storing an array with values from the six Results.

Defined in

src/Combiner.ts:75


Combine7()

static Combine7<T1, T2, T3, T4, T5, T6, T7>(r1, r2, r3, r4, r5, r6, r7): Result<[T1, T2, T3, T4, T5, T6, T7]>

Combines seven Results into one.

Type Parameters

T1

T2

T3

T4

T5

T6

T7

Parameters

r1: Result<T1>

First Result.

r2: Result<T2>

Second Result.

r3: Result<T3>

Third Result.

r4: Result<T4>

Fourth Result.

r5: Result<T5>

Fifth Result.

r6: Result<T6>

Sixth Result.

r7: Result<T7>

Seventh Result.

Returns

Result<[T1, T2, T3, T4, T5, T6, T7]>

New Result storing an array with values from the seven Results.

Defined in

src/Combiner.ts:106


CombineFactories()

static CombineFactories<T>(factories, options?): Result<T[]>

Combines multiple Result factories into one, handling concurrency and errors.

Type Parameters

T

Parameters

factories: () => Result<T>[]

Array of functions that create Results.

options?: CombineFactoriesOptionsType

Optional settings for combining factories.

Returns

Result<T[]>

New Result storing an array of values produced by the factories.

Defined in

src/Combiner.ts:153


CombineMany()

static CombineMany<T>(results): Result<T[]>

Combines an array of Results into one, failing if any of the promises fail.

Type Parameters

T

Parameters

results: Result<T>[]

Array of Results to combine.

Returns

Result<T[]>

New Result storing an array with values from the Results.

Defined in

src/Combiner.ts:133


CombineSettled()

static CombineSettled<T>(results): Result<PromiseSettledResult<Awaited<T>>[]>

Combines an array of Results into one, never failing and returning information about which Results succeeded and which failed.

Type Parameters

T

Parameters

results: Result<T>[]

Array of Results to combine.

Returns

Result<PromiseSettledResult<Awaited<T>>[]>

New Result storing an array of PromiseSettledResult objects.

Defined in

src/Combiner.ts:143