is_what.isOneOf | /src/deps.ts | libpkgx@v0.18.1

function is_what.isOneOf

import { is_what } from "https://deno.land/x/libpkgx@v0.18.1/src/deps.ts";
const { isOneOf } = is_what;

isOneOf<A, B extends A, C extends A>(a: TypeGuard<A, B>, b: TypeGuard<A, C>): TypeGuard<A, B | C>

A factory function that creates a function to check if the payload is one of the given types.

isOneOf<A, B extends A, C extends A, D extends A>(

a: TypeGuard<A, B>,

b: TypeGuard<A, C>,

c: TypeGuard<A, D>,

): TypeGuard<A, B | C | D>

A factory function that creates a function to check if the payload is one of the given types.

isOneOf<A, B extends A, C extends A, D extends A, E extends A>(

a: TypeGuard<A, B>,

b: TypeGuard<A, C>,

c: TypeGuard<A, D>,

d: TypeGuard<A, E>,

): TypeGuard<A,

| B

| C

| D

| E

A factory function that creates a function to check if the payload is one of the given types.

isOneOf<A, B extends A, C extends A, D extends A, E extends A, F extends A>(

a: TypeGuard<A, B>,

b: TypeGuard<A, C>,

c: TypeGuard<A, D>,

d: TypeGuard<A, E>,

e: TypeGuard<A, F>,

): TypeGuard<A,

| B

| C

| D

| E

| F

A factory function that creates a function to check if the payload is one of the given types.

Examples

import { isOneOf, isNull, isUndefined } from 'is-what'

const isNullOrUndefined = isOneOf(isNull, isUndefined)

isNullOrUndefined(null) // true isNullOrUndefined(undefined) // true isNullOrUndefined(123) // false

Type Parameters

B extends A

C extends A

Parameters

a: TypeGuard<A, B>

b: TypeGuard<A, C>

Returns

TypeGuard<A, B | C>

A factory function that creates a function to check if the payload is one of the given types.

Examples

import { isOneOf, isNull, isUndefined } from 'is-what'

const isNullOrUndefined = isOneOf(isNull, isUndefined)

isNullOrUndefined(null) // true isNullOrUndefined(undefined) // true isNullOrUndefined(123) // false

Type Parameters

B extends A

C extends A

D extends A

Parameters

a: TypeGuard<A, B>

b: TypeGuard<A, C>

c: TypeGuard<A, D>

Returns

TypeGuard<A, B | C | D>

A factory function that creates a function to check if the payload is one of the given types.

Examples

import { isOneOf, isNull, isUndefined } from 'is-what'

const isNullOrUndefined = isOneOf(isNull, isUndefined)

isNullOrUndefined(null) // true isNullOrUndefined(undefined) // true isNullOrUndefined(123) // false

Type Parameters

B extends A

C extends A

D extends A

E extends A

Parameters

a: TypeGuard<A, B>

b: TypeGuard<A, C>

c: TypeGuard<A, D>

d: TypeGuard<A, E>

Returns

TypeGuard<A,

| B

| C

| D

| E

A factory function that creates a function to check if the payload is one of the given types.

Examples

import { isOneOf, isNull, isUndefined } from 'is-what'

const isNullOrUndefined = isOneOf(isNull, isUndefined)

isNullOrUndefined(null) // true isNullOrUndefined(undefined) // true isNullOrUndefined(123) // false

Type Parameters

B extends A

C extends A

D extends A

E extends A

F extends A

Parameters

a: TypeGuard<A, B>

b: TypeGuard<A, C>

c: TypeGuard<A, D>

d: TypeGuard<A, E>

e: TypeGuard<A, F>

Returns

TypeGuard<A,

| B

| C

| D

| E

| F