None if the Option is None, otherwise returns optionB.
Arguments passed to and are eagerly evaluated; if you are passing the result of a function call, it is recommended to use andThen, which is lazily evaluated.
Transforms the Option<T> into a Result<T, E>, mapping Some(v) to Ok(v) and None to Err(err).
Arguments passed to okOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use okOrElse, which is lazily evaluated.
the Option if it contains a value, otherwise returns optionB.
Arguments passed to or are eagerly evaluated; if you are passing the result of a function call, it is recommended to use orElse, which is lazily evaluated.
Arguments passed to unwrapOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrapOrElse, which is lazily evaluated.
Arguments passed to unwrapOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrapOrElse, which is lazily evaluated.
the Result if it is Ok, otherwise returns resultB.
Arguments passed to or are eagerly evaluated; if you are passing the result of a function call, it is recommended to use orElse, which is lazily evaluated.
Arguments passed to unwrapErrOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrapErrOrElse, which is lazily evaluated.
Arguments passed to unwrapErrOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrapErrOrElse, which is lazily evaluated.
Arguments passed to unwrapOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrapOrElse, which is lazily evaluated.
The
Optiontype is an immutable representation of an optional value: +- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Class Option<T>
The
-Optiontype is an immutable representation of an optional value: everyOptionis eitherSomeand contains a value, orNoneand does not.Type Parameters
Index
Properties
Type Parameters
Index
Properties
Methods
Properties
StaticNoneThe
-Nonevalue.Methods
[iterator]
Returns an iterator over the possibly contained value.
+Methods
[iterator]
Returns an iterator over the possibly contained value.
The iterator yields one value if the result is
-Some, otherwise none.Returns Generator<T, void, unknown>
and
Type Parameters
Parameters
An
+OptionReturns Generator<T, void, unknown>
and
Type Parameters
Parameters
An
OptionReturns Option<B>
Noneif theOptionisNone, otherwise returnsoptionB.Arguments passed to
-andare eagerly evaluated; if you are passing the result of a function call, it is recommended to useandThen, which is lazily evaluated.and
Type Parameters
Parameters
A function that returns an
+Optionand
Type Parameters
Parameters
A function that returns an
OptionParameters
Returns Option<B>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<B>
-Noneif theOptionisNone, otherwise callsgetOptionBwith the wrapped value and returns the result.filter
Returns
+Noneif theOptionisNone, otherwise calls predicate with the wrapped value and returns:filter
Returns
Noneif theOptionisNone, otherwise calls predicate with the wrapped value and returns:Some(t)if predicate returnstrue(wheretis the wrapped value with inferred new type), andNoneif predicate returnsfalse.Type Parameters
Parameters
A type predicate function that defines type guard by returning
trueorfalse.Parameters
Returns value is U
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
-undefinedis used instead.Returns Option<U>
Returns
+Noneif theOptionisNone, otherwise calls predicate with the wrapped value and returns:Returns Option<U>
Returns
Noneif theOptionisNone, otherwise calls predicate with the wrapped value and returns:Some(t)if predicate returnstrue(wheretis the wrapped value), andNoneif predicate returnsfalse.Parameters
A function that returns
trueorfalse.Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
-undefinedis used instead.Returns Option<T>
flatten
Converts from
-Option<Option<T>>toOption<T>Returns Option<UnwrapOption<T, T>>
is
Returns boolean
-trueif theOptionis aNone.is
Whether
+thisvalue is the same as the otherOption.Returns Option<T>
flatten
Converts from
+Option<Option<T>>toOption<T>Returns Option<UnwrapOption<T, T>>
is
Returns boolean
+trueif theOptionis aNone.is
Whether
thisvalue is the same as the otherOption.Parameters
Another
Optionor any valueReturns boolean
-trueif the other is anOptionand the value are the same asthisvalue viaObject.is.is
Returns boolean
-trueif theOptionis aSome.is
Parameters
A function that returns
+trueif the value satisfies the predicate, otherwisefalseis
Returns boolean
+trueif theOptionis aSome.is
Parameters
A function that returns
trueif the value satisfies the predicate, otherwisefalseParameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns boolean
-trueif theOptionis aSomeand and the value inside of it matches a predicate.map
Maps an
+Option<T>toOption<U>by applying a function to a contained value (ifSome) or returnsNone(ifNone).map
Maps an
Option<T>toOption<U>by applying a function to a contained value (ifSome) or returnsNone(ifNone).Type Parameters
Parameters
A function that maps a value to another value
Parameters
Returns U
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<U>
-Noneif theOptionisNone, otherwise returnsSome(fn(value)).match
Extract the value from an
+Optionin a way that handles both theSomeandNonecases.match
Extract the value from an
Optionin a way that handles both theSomeandNonecases.Type Parameters
Parameters
A function that returns a value if the
Optionis aSome.Parameters
Returns U
A function that returns a value if the
Optionis aNone.Returns U
Returns U
The value returned by the provided function.
-ok
Transforms the
+Option<T>into aResult<T, E>, mappingSome(v)toOk(v)and None toErr(err).ok
Transforms the
Option<T>into aResult<T, E>, mappingSome(v)toOk(v)and None toErr(err).Arguments passed to
okOrare eagerly evaluated; if you are passing the result of a function call, it is recommended to useokOrElse, which is lazily evaluated.Type Parameters
Parameters
The error value for
-Errif theOptionisNone.Returns Result<T, E>
ok
Transforms the
+Option<T>into aResult<T, E>, mappingSome(v)toOk(v)andNonetoErr(err()).Returns Result<T, E>
ok
Transforms the
Option<T>into aResult<T, E>, mappingSome(v)toOk(v)andNonetoErr(err()).Type Parameters
Parameters
A function that returns the error value for
Errif theOptionisNone.Returns E
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
-undefinedis used instead.Returns Result<T, E>
or
Type Parameters
Parameters
An
+OptionReturns Result<T, E>
or
Type Parameters
Parameters
An
OptionReturns Option<T | B>
the
Optionif it contains a value, otherwise returnsoptionB.Arguments passed to or are eagerly evaluated; if you are passing the result of a function call, it is recommended to use
-orElse, which is lazily evaluated.or
Type Parameters
Parameters
A function that returns an
+Optionor
Type Parameters
Parameters
A function that returns an
OptionReturns Option<B>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<T | B>
the
-Optionif it contains a value, otherwise callsgetOptionBand returns the result.to
Returns string
transpose
Transposes an
+Option(Result)intoResult(Option).to
Returns string
transpose
Transposes an
Option(Result)intoResult(Option).
-Nonewill be mapped toOk(None).Some(Ok(_))andSome(Err(_))will be mapped toOk(Some(_))andErr(_).Some(value)will be mapped toOk(Some(value)).Returns Result<Option<UnwrapOk<T>>, UnwrapErr<T>>
unwrap
Parameters
Optional Error message
+Returns Result<Option<UnwrapOk<T>>, UnwrapErr<T>>
unwrap
Parameters
Optional Error message
Returns T
the contained
Somevalue.Throws
if the value is a None.
-unwrap
Returns undefined | T
the contained
+Somevalue orundefinedotherwise.unwrap
Returns undefined | T
the contained
Somevalue orundefinedotherwise.Arguments passed to
-unwrapOrare eagerly evaluated; if you are passing the result of a function call, it is recommended to useunwrapOrElse, which is lazily evaluated.Type Parameters
Parameters
default value
+Type Parameters
Parameters
default value
Returns T | U
the contained
Somevalue or a provided default.Arguments passed to
-unwrapOrare eagerly evaluated; if you are passing the result of a function call, it is recommended to useunwrapOrElse, which is lazily evaluated.unwrap
Type Parameters
Parameters
A function that computes a default value.
+unwrap
Type Parameters
Parameters
A function that computes a default value.
Returns U
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns T | U
the contained
-Somevalue or computes it from a closure.unzip
? T<T>[0]
: unknown>, Option<T extends any[]
? T<T>[1]
: unknown>]
Unzips an
+Optioncontaining a tuple of twoOptions.unzip
? T<T>[0]
: unknown>, Option<T extends any[]
? T<T>[1]
: unknown>]
Unzips an
Optioncontaining a tuple of twoOptions.Returns [Option<T extends any[]
? T<T>[0]
: unknown>, Option<T extends any[]
? T<T>[1]
: unknown>]
-[Some(a), Some(b)]ifthisisSome([a, b]), otherwise[None, None].xor
Type Parameters
Parameters
An
+Optionxor
Type Parameters
Parameters
An
OptionReturns Option<T | B>
-Someif exactly one ofthisandoptionBisSome, otherwise returnsNone.zip
Zips
+thiswith anotherOption.zip
Zips
thiswith anotherOption.Type Parameters
Parameters
Returns Option<[T, B]>
-Some([a, b])ifthisisSome(a)and other isSome(b), otherwiseNone.zip
Zips
+thisand anotherOptionwith functionfn.zip
Zips
thisand anotherOptionwith functionfn.Type Parameters
Parameters
Parameters
Returns U
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<U>
-Some(fn(a, b))ifthisisSome(a)and other isSome(b), otherwiseNone.StaticfromWrap a value in an
+Optionif the value is truthy.StaticfromWrap a value in an
Optionif the value is truthy.Type Parameters
Parameters
A value of type
-TReturns Option<Exclude<T, Falsy>>
Wrap a value in an
+Optionif the value satisfies the predicate.Returns Option<Exclude<T, Falsy>>
Wrap a value in an
Optionif the value satisfies the predicate.Type Parameters
Parameters
Source value
A function that returns
trueif the value satisfies the predicate, otherwisefalseParameters
Returns source is T
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
-undefinedis used instead.Returns Option<T>
Wrap a value in an
+Optionif the value satisfies the predicate.Returns Option<T>
Wrap a value in an
Optionif the value satisfies the predicate.Type Parameters
Parameters
Source value
A function that returns
-trueif the value satisfies the predicate, otherwisefalseParameters
Returns boolean
OptionalthisArg: anyReturns Option<T>
StaticisType Parameters
Parameters
A value that might be an
+OptionParameters
Returns boolean
OptionalthisArg: anyReturns Option<T>
StaticisType Parameters
Parameters
A value that might be an
OptionReturns maybeOption is Option<T>
-trueif the given value is anOption.StaticisParameters
An
+Optionor any valueStaticisParameters
An
Optionor any valueAn
Optionor any valueReturns boolean
-trueif the both areOptionand the value are the same viaObject.is.StaticSomeType Parameters
Parameters
A value of type
+TStaticSomeType Parameters
Parameters
A value of type
TReturns Option<T>
Wrap a value into an
-Option.StaticunwrapType Parameters
Parameters
A value of type
+Tor anOption<T>StaticunwrapType Parameters
Parameters
A value of type
Tor anOption<T>Returns undefined | T
the
-unwrapOr()result if the value is anOption, otherwise the value itself.Settings
On This Page
Properties
Methods
Settings
On This Page
Properties
Methods
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Class Result<T, E>
The
-Resulttype is an immutable representation of either success (Ok) or failure (Err).Type Parameters
Index
Methods
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Class Result<T, E>
The
+Resulttype is an immutable representation of either success (Ok) or failure (Err).Type Parameters
Index
Methods
Methods
[iterator]
Returns an iterator over the possibly contained value.
The iterator yields one value if the result is
-Ok, otherwise none.Returns Generator<T, void, unknown>
and
Type Parameters
Parameters
Returns Result<BT, E | BE>
and
Type Parameters
Parameters
A function that returns a
+ResultReturns Generator<T, void, unknown>
and
Type Parameters
Parameters
Returns Result<BT, E | BE>
and
Type Parameters
Parameters
A function that returns a
ResultParameters
Returns Result<BT, BE>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Result<BT, E | BE>
-Errif theResultisErr, otherwise callsgetOptionBwith the wrapped value and returns the result.err
Converts from
-Result<T, E>toOption<E>and discarding the value, if any.Returns Option<E>
flatten
Converts from
-Option<Option<T>>toOption<T>Returns Result<UnwrapOk<T, T>, E | UnwrapErr<E, E>>
is
Returns boolean
-trueif theResultis anErr.is
Parameters
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
+undefinedis used instead.err
Converts from
+Result<T, E>toOption<E>and discarding the value, if any.Returns Option<E>
flatten
Converts from
+Option<Option<T>>toOption<T>Returns Result<UnwrapOk<T, T>, E | UnwrapErr<E, E>>
is
Returns boolean
+trueif theResultis anErr.is
Parameters
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns boolean
-trueif theResultis anErrand and the error inside of it matches a predicate.is
Returns boolean
-trueif theResultis anOk.is
Parameters
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
+undefinedis used instead.is
Returns boolean
+trueif theResultis anOk.is
Parameters
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns boolean
-trueif theResultis anOkand and the value inside of it matches a predicate.is
Whether
+thisOkvalue orErrerror is the same as the otherResult.is
Whether
thisOkvalue orErrerror is the same as the otherResult.Parameters
Another
Resultor any valueReturns boolean
-trueif the other is anResultand theOkvalue orErrerror is the same asthisviaObject.is.map
Maps an
+Result<T, E>toResult<U, E>by applying a function to a containedOkvalue, leaving anErrvalue untouched.map
Maps an
Result<T, E>toResult<U, E>by applying a function to a containedOkvalue, leaving anErrvalue untouched.Type Parameters
Parameters
A function that maps a value to another value
Parameters
Returns U
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Result<U, E>
-Errif theResultisErr, otherwise returnsOk(fn(value)).map
Maps a
+Result<T, E>toResult<T, F>by applying a function to a containedErrvalue, leaving anOkvalue untouched.map
Maps a
Result<T, E>toResult<T, F>by applying a function to a containedErrvalue, leaving anOkvalue untouched.This function can be used to pass through a successful result while handling an error.
Type Parameters
Parameters
A function that maps a error to another error
Parameters
Returns U
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Result<T, U>
-Okif theResultisOk, otherwise returnsErr(fn(error)).match
Extract the value from an
+Resultin a way that handles both theOkandErrcases.match
Extract the value from an
Resultin a way that handles both theOkandErrcases.Type Parameters
Parameters
A function that returns a value if the
Resultis aOk.Parameters
Returns U
A function that returns a value if the
Resultis aErr.Parameters
Returns U
Returns U
The value returned by the provided function.
-ok
Converts from
-Result<T, E>toOption<T>and discarding the error, if any.Returns Option<T>
or
Type Parameters
Parameters
A
+Resultok
Converts from
+Result<T, E>toOption<T>and discarding the error, if any.Returns Option<T>
or
Type Parameters
Parameters
A
ResultReturns Result<T | BT, E | BE>
the
Resultif it isOk, otherwise returnsresultB.Arguments passed to
-orare eagerly evaluated; if you are passing the result of a function call, it is recommended to useorElse, which is lazily evaluated.or
Type Parameters
Parameters
A function that returns an
+Resultor
Type Parameters
Parameters
A function that returns an
ResultReturns Result<BT, BE>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Result<T | BT, E | BE>
the
-Resultif it contains a value, otherwise callsgetResultBand returns the result.to
Returns string
transpose
Transposes a
+Result(Option)intoOption(Result).to
Returns string
transpose
Transposes a
Result(Option)intoOption(Result).
-Ok(Some(_))will be mapped to `Some(Ok(_))Err(_)will be mapped toSome(Err(_)).Ok(_)will be mapped toSome(Ok(_)).Returns Option<Result<UnwrapOption<T>, E>>
unwrap
Parameters
Optional Error message
+Returns Option<Result<UnwrapOption<T>, E>>
unwrap
Parameters
Optional Error message
Returns T
the contained
Okvalue.Throws
if the value is an
-Err.unwrap
Parameters
Optional Error message
+unwrap
Parameters
Optional Error message
Returns E
the contained
Errerror.Throws
if the error is an
-Ok.unwrap
Returns undefined | E
the contained
+Errerror orundefinedotherwise.unwrap
Returns undefined | E
the contained
Errerror orundefinedotherwise.Arguments passed to
-unwrapErrOrare eagerly evaluated; if you are passing the result of a function call, it is recommended to useunwrapErrOrElse, which is lazily evaluated.Type Parameters
Parameters
default error
+Type Parameters
Parameters
default error
Returns E | U
the contained
Errerror or a provided default.Arguments passed to
-unwrapErrOrare eagerly evaluated; if you are passing the result of a function call, it is recommended to useunwrapErrOrElse, which is lazily evaluated.unwrap
Type Parameters
Parameters
A function that computes a default value.
+unwrap
Type Parameters
Parameters
A function that computes a default value.
Returns U
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns E | U
the contained
-Errerror or computes it from a closure.unwrap
Returns undefined | T
the contained
-Okvalue orundefinedotherwise.Type Parameters
Parameters
default value
+unwrap
Returns undefined | T
the contained
+Okvalue orundefinedotherwise.Type Parameters
Parameters
default value
Returns T | U
the contained
Okvalue or a provided default.Arguments passed to
-unwrapOrare eagerly evaluated; if you are passing the result of a function call, it is recommended to useunwrapOrElse, which is lazily evaluated.unwrap
Type Parameters
Parameters
A function that computes a default value.
+unwrap
Type Parameters
Parameters
A function that computes a default value.
Returns U
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns T | U
the contained
-Okvalue or computes it from a closure.StaticReadonlyErrType Parameters
Parameters
An error of type
+EStaticReadonlyErrType Parameters
Parameters
An error of type
EReturns Result<T, E>
Wrap an error into an
-Result.Staticfrom
-Errif the value is anError.Type Parameters
Parameters
Returns Result<T, E>
+OKif the value satisfies the predicate, otherwiseErrStaticfrom
+Errif the value is anError.Type Parameters
Parameters
Returns Result<T, E>
OKif the value satisfies the predicate, otherwiseErrType Parameters
Parameters
Source value
A function that returns
trueif the value satisfies the predicate, otherwisefalseParameters
Returns source is T
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
-undefinedis used instead.Returns Result<T, E>
+OKif the value satisfies the predicate, otherwiseErrReturns Result<T, E>
OKif the value satisfies the predicate, otherwiseErrType Parameters
Parameters
Source value
A function that returns
trueif the value satisfies the predicate, otherwisefalseParameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
-undefinedis used instead.Returns Result<T, E>
StaticisType Parameters
Parameters
A value that might be an
+ResultReturns Result<T, E>
StaticisType Parameters
Parameters
A value that might be an
ResultReturns maybeResult is Result<T, E>
-trueif the given value is anResult.StaticisParameters
An
+Resultor any valueStaticisParameters
An
Resultor any valueAn
Resultor any valueReturns boolean
-trueif the both areResultand theOkvalue orErrerror are the same viaObject.is.StaticReadonlyOkType Parameters
Parameters
A value of type
+TStaticReadonlyOkType Parameters
Parameters
A value of type
TReturns Result<T, E>
Wrap a value into an
-Result.Statictry
+Okif thefnreturns a value,Errif thefnthrows.StatictryOkif thefnreturns a value,Errif thefnthrows.Type Parameters
Parameters
Parameters
Rest...args: TArgsReturns T
Rest...args: TArgsReturns Result<T, E>
-Okwith the returned value orErrwith the exception error.Statictry
+Okif thefnreturned Promise resolves a value,Errif thefnthrows or the Promise rejected.StatictryOkif thefnreturned Promise resolves a value,Errif thefnthrows or the Promise rejected.Type Parameters
Parameters
Parameters
Rest...args: TArgsReturns T
Rest...args: TArgsReturns Promise<Result<T, E>>
-Okwith the resolved value orErrwith the exception error or the rejected value.Settings
On This Page
Methods
Settings
On This Page
Methods
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function Err
Param: error
An error of type
+E- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function Err
Param: error
An error of type
EReturns
Wrap an error into an
Result.Type Parameters
Parameters
An error of type
EReturns Result<T, E>
Wrap an error into an
-Result.Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function Ok
Param: value
A value of type
+T- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function Ok
Param: value
A value of type
TReturns
Wrap a value into an
Result.Type Parameters
Parameters
A value of type
TReturns Result<T, E>
Wrap a value into an
-Result.Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function Some
Param: value
A value of type
+T- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function Some
Param: value
A value of type
TReturns
Wrap a value into an
Option.Type Parameters
Parameters
A value of type
TReturns Option<T>
Wrap a value into an
-Option.Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function filterMap
+filterMapfilers and maps an iterable at the same time.- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function filterMap
filterMapfilers and maps an iterable at the same time.It makes chains of
filterandmapmore concise, as it shortensmap().filter().map()to a single call.Type Parameters
Parameters
An array
A function that produces an
Option.Parameters
Returns Option<U>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns U[]
An array of filtered and mapped values.
-Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function first
+firstfinds the first item that matches a predicate. Returns the first item of array if no predicate is provided.- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function first
firstfinds the first item that matches a predicate. Returns the first item of array if no predicate is provided.Type Parameters
Parameters
An array
A predicate function.
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, the first element is returned.
Returns Option<T>
The first item that matches the predicate, or
-Noneif no item matches.Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function firstIndex
Returns the index of the first element in the array that satisfies the provided testing function. Otherwise
+Noneis returned.- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function firstIndex
Returns the index of the first element in the array that satisfies the provided testing function. Otherwise
Noneis returned.Type Parameters
Parameters
An array
A predicate function.
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<number>
The index of the first item that matches the predicate, or
-Noneif no item matches.Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function firstMap
Applies function to the elements of iterator and returns the first non-none result.
+- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function firstMap
Applies function to the elements of iterator and returns the first non-none result.
firstMap(fn)is the lighter version offilterMap(fn).first().Type Parameters
Parameters
An array
A function that produces an
Option.Parameters
Returns Option<U>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<U>
The first non-none result.
-Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function last
+lastfinds the last item that matches a predicate. Returns the last item of array if no predicate is provided.- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function last
lastfinds the last item that matches a predicate. Returns the last item of array if no predicate is provided.Type Parameters
Parameters
An array
A predicate function.
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, the last element is returned.
Returns Option<T>
The last item that matches the predicate, or
-Noneif no item matches.Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function lastIndex
Returns the index of the last element in the array where predicate is true, and
+Noneotherwise.- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function lastIndex
Returns the index of the last element in the array where predicate is true, and
Noneotherwise.Type Parameters
Parameters
An array
lastIndex calls predicate once for each element of the array, in backward order, until it finds one where predicate returns true.
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<number>
The index of the last item that matches the predicate, or
-Noneif no item matches.Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function lastMap
+lastMap(fn)is the lighter version offilterMap(fn).last().- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function lastMap
lastMap(fn)is the lighter version offilterMap(fn).last().Type Parameters
Parameters
An array
A function that produces an
Option.Parameters
Returns Option<U>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<U>
The last non-none result.
-Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function mapWhile
+mapWhilemaps an iterable until the firstNoneis encountered.- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function mapWhile
mapWhilemaps an iterable until the firstNoneis encountered.Type Parameters
Parameters
An array
A function that produces an
Option.Parameters
Returns Option<U>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns U[]
An array of mapped values.
-Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Function reduceWhile
+reduceWhilereduces an iterable until the firstNoneis encountered.- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Function reduceWhile
reduceWhilereduces an iterable until the firstNoneis encountered.Type Parameters
Parameters
An array
A function that produces an
Option.Parameters
Returns Option<U>
The initial value.
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns U
The reduced value.
-Settings
Settings
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4@wopjs/tsur - v0.1.4
tsur
+
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5@wopjs/tsur - v0.1.5
tsur
See docs for more details.
License
MIT @ CRIMX
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Interface ResultMatcher<T, E, U>
Err: ((error: E) => U);
Ok: ((value: T) => U);
}
Type Parameters
Index
Properties
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Interface ResultMatcher<T, E, U>
Err: ((error: E) => U);
Ok: ((value: T) => U);
}
Type Parameters
Index
Properties
Properties
Err
Ok
Settings
On This Page
Properties
Properties
Err
Ok
Settings
On This Page
Properties
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.4Interface Array<T>
$filterMap<U>(fn: ((value: T, index: number, array: T[]) => Option<U>), thisArg?: any): U[];
$first(predicate?: ((value: T, index: number, array: T[]) => boolean), thisArg?: any): Option<T>;
$firstIndex(predicate: ((value: T, index: number, array: T[]) => boolean), thisArg?: any): Option<number>;
$firstMap<U>(fn: ((value: T, index: number, array: T[]) => Option<U>), thisArg?: any): Option<U>;
$last(predicate?: ((value: T, index: number, array: T[]) => boolean), thisArg?: any): Option<T>;
$lastIndex(predicate: ((value: T, index: number, array: T[]) => boolean), thisArg?: any): Option<number>;
$lastMap<U>(fn: ((value: T, index: number, array: T[]) => Option<U>), thisArg?: any): Option<U>;
$mapWhile<U>(fn: ((value: T, index: number, array: T[]) => Option<U>), thisArg?: any): U[];
$reduceWhile<U>(fn: ((previousValue: U, currentValue: T, currentIndex: number, array: T[]) => Option<U>), initialValue: U, thisArg?: any): U;
}
Type Parameters
Index
Methods
- Preparing search index...
- The search index is not available
@wopjs/tsur - v0.1.5Interface Array<T>
$filterMap<U>(fn: ((value: T, index: number, array: T[]) => Option<U>), thisArg?: any): U[];
$first(predicate?: ((value: T, index: number, array: T[]) => boolean), thisArg?: any): Option<T>;
$firstIndex(predicate: ((value: T, index: number, array: T[]) => boolean), thisArg?: any): Option<number>;
$firstMap<U>(fn: ((value: T, index: number, array: T[]) => Option<U>), thisArg?: any): Option<U>;
$last(predicate?: ((value: T, index: number, array: T[]) => boolean), thisArg?: any): Option<T>;
$lastIndex(predicate: ((value: T, index: number, array: T[]) => boolean), thisArg?: any): Option<number>;
$lastMap<U>(fn: ((value: T, index: number, array: T[]) => Option<U>), thisArg?: any): Option<U>;
$mapWhile<U>(fn: ((value: T, index: number, array: T[]) => Option<U>), thisArg?: any): U[];
$reduceWhile<U>(fn: ((previousValue: U, currentValue: T, currentIndex: number, array: T[]) => Option<U>), initialValue: U, thisArg?: any): U;
}
Type Parameters
Index
Methods
Type Parameters
Parameters
A function that produces an
Option.Parameters
Returns Option<U>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns U[]
An array of filtered and mapped values.
-$first
From tsur.
+$first
From tsur.
firstfinds the first item that matches a predicate. Returns the first item of array if no predicate is provided.Parameters
Optionalpredicate: ((value: T, index: number, array: T[]) => boolean)A predicate function.
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<T>
The first item that matches the predicate, or
-Noneif no item matches.$first
From tsur.
+$first
From tsur.
Returns the index of the first element in the array that satisfies the provided testing function. Otherwise
Noneis returned.Parameters
A predicate function.
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<number>
The index of the first item that matches the predicate, or
-Noneif no item matches.$first
From tsur.
+$first
From tsur.
Applies function to the elements of iterator and returns the first non-none result.
firstMap(fn)is the lighter version offilterMap(fn).first().Type Parameters
Parameters
A function that produces an
Option.Parameters
Returns Option<U>
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<U>
The first non-none result.
-$last
From tsur.
+$last
From tsur.
lastfinds the last item that matches a predicate. Returns the last item of array if no predicate is provided.Parameters
Optionalpredicate: ((value: T, index: number, array: T[]) => boolean)A predicate function.
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<T>
The last item that matches the predicate, or
-Noneif no item matches.$last
From tsur.
+$last
From tsur.
Returns the index of the last element in the array where predicate is true, and
Noneotherwise.Parameters
lastIndex calls predicate once for each element of the array, in backward order, until it finds one where predicate returns true.
Parameters
Returns boolean
OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided,
undefinedis used instead.Returns Option<number>
The index of the last item that matches the predicate, or
-Noneif no item matches.$last
From tsur.
+$last
From tsur.
lastMap(fn)is the lighter version offilterMap(fn).last().Type Parameters
Parameters
A function that produces an
Option.Parameters