ts-data-forge
Version:
[](https://www.npmjs.com/package/ts-data-forge) [](https://www.npmjs.com/package/ts-data-forge) [ • 667 B
JavaScript
import { SomeTypeTagName } from './tag.mjs';
/**
* Checks if an {@link Optional} is {@link Some}. Acts as a type guard.
*
* @example
*
* ```ts
* const optionalNumber = Optional.some(42);
*
* if (Optional.isSome(optionalNumber)) {
* const value: number = optionalNumber.value;
*
* assert.isTrue(value === 42);
* }
* ```
*
* @template O The {@link UnknownOptional} type to check.
* @param optional The {@link Optional} to check.
* @returns `true` if the {@link Optional} is {@link Some}, `false`
* otherwise.
*/
const isSome = (optional) => optional.$$tag === SomeTypeTagName;
export { isSome };
//# sourceMappingURL=optional-is-some.mjs.map