<B>(onNone: LazyArg<B>): <A>(self: Option<A>) => Option<B | A>
<A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>Returns Some of the fallback value if self is None; otherwise returns
self.
When to use
Use when providing a default plain value (not an Option) as fallback
Details
Some→ returnsselfunchangedNone→ callsonNone(), wraps result inSome, and returns it
Example (Providing a fallback value)
import { Option } from "effect"
console.log(Option.none().pipe(Option.orElseSome(() => "b")))
// Output: { _id: 'Option', _tag: 'Some', value: 'b' }
console.log(Option.some("a").pipe(Option.orElseSome(() => "b")))
// Output: { _id: 'Option', _tag: 'Some', value: 'a' }export const const orElseSome: {
<B>(onNone: LazyArg<B>): <A>(
self: Option<A>
) => Option<B | A>
<A, B>(
self: Option<A>,
onNone: LazyArg<B>
): Option<A | B>
}
Returns Some of the fallback value if self is None; otherwise returns
self.
When to use
Use when providing a default plain value (not an Option) as fallback
Details
Some → returns self unchangedNone → calls onNone(), wraps result in Some, and returns it
Example (Providing a fallback value)
import { Option } from "effect"
console.log(Option.none().pipe(Option.orElseSome(() => "b")))
// Output: { _id: 'Option', _tag: 'Some', value: 'b' }
console.log(Option.some("a").pipe(Option.orElseSome(() => "b")))
// Output: { _id: 'Option', _tag: 'Some', value: 'a' }
orElseSome: {
<function (type parameter) B in <B>(onNone: LazyArg<B>): <A>(self: Option<A>) => Option<B | A>B>(onNone: LazyArg<B>onNone: import LazyArgLazyArg<function (type parameter) B in <B>(onNone: LazyArg<B>): <A>(self: Option<A>) => Option<B | A>B>): <function (type parameter) A in <A>(self: Option<A>): Option<B | A>A>(self: Option<A>self: type Option<A> = None<A> | Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<function (type parameter) A in <A>(self: Option<A>): Option<B | A>A>) => type Option<A> = None<A> | Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<function (type parameter) B in <B>(onNone: LazyArg<B>): <A>(self: Option<A>) => Option<B | A>B | function (type parameter) A in <A>(self: Option<A>): Option<B | A>A>
<function (type parameter) A in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>A, function (type parameter) B in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>B>(self: Option<A>self: type Option<A> = None<A> | Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<function (type parameter) A in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>A>, onNone: LazyArg<B>onNone: import LazyArgLazyArg<function (type parameter) B in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>B>): type Option<A> = None<A> | Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<function (type parameter) A in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>A | function (type parameter) B in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>B>
} = import dualdual(
2,
<function (type parameter) A in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>A, function (type parameter) B in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>B>(self: Option<A>self: type Option<A> = None<A> | Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<function (type parameter) A in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>A>, onNone: LazyArg<B>onNone: import LazyArgLazyArg<function (type parameter) B in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>B>): type Option<A> = None<A> | Some<A>The Option data type represents optional values. An Option<A> is either
Some<A>, containing a value of type A, or None, representing absence.
When to use
Use to represent initial values that may not yet exist
- Returning from partial functions (not defined for all inputs)
- Managing optional fields in data structures
Namespace containing utility types for Option.
When to use
Use to access type-level helpers associated with Option.
Option<function (type parameter) A in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>A | function (type parameter) B in <A, B>(self: Option<A>, onNone: LazyArg<B>): Option<A | B>B> => const isNone: <A>(
self: Option<A>
) => self is None<A>
Checks whether an Option is None (absent).
When to use
Use when you need to branch on an absent Option before accessing .value.
Details
- Acts as a type guard, narrowing to
None<A>
Example (Checking for None)
import { Option } from "effect"
console.log(Option.isNone(Option.some(1)))
// Output: false
console.log(Option.isNone(Option.none()))
// Output: true
isNone(self: Option<A>self) ? const some: <A>(value: A) => Option<A>Wraps the given value into an Option to represent its presence.
When to use
Use to wrap a known present value as Option
- Returning a successful result from a partial function
Details
- Always returns
Some<A>
- Does not filter
null or undefined; use
fromNullishOr
for that
Example (Wrapping a value)
import { Option } from "effect"
// ┌─── Option<number>
// ▼
const value = Option.some(1)
console.log(value)
// Output: { _id: 'Option', _tag: 'Some', value: 1 }
some(onNone: LazyArg<B>onNone()) : self: Option<A>(parameter) self: {
_tag: "Some";
_op: "Some";
value: A;
valueOrUndefined: A;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}