orbit-oss/is
5
5
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add .asyncGenerator and .asyncGeneratorFunction detection

Browse source
This commit is contained in:
forresst 2019-12-27 07:59:58 +01:00
parent aeb3f74d65
commit b90db352a3
2 changed files with 50 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
source/index.ts
View file

@ -14,7 +14,9 @@ export const enum TypeName {
symbol = 'symbol',
Function = 'Function',
Generator = 'Generator',
AsyncGenerator = 'AsyncGenerator',
GeneratorFunction = 'GeneratorFunction',
AsyncGeneratorFunction = 'AsyncGeneratorFunction',
AsyncFunction = 'AsyncFunction',
Observable = 'Observable',
Array = 'Array',
@ -141,6 +143,8 @@ is.asyncIterable = (value: unknown): value is AsyncIterableIterator<unknown> =>
is.generator = (value: unknown): value is Generator => is.iterable(value) && is.function_(value.next) && is.function_(value.throw);
is.asyncGenerator = (value: unknown): value is AsyncGenerator => is.asyncIterable(value) && is.function_(value.next) && is.function_(value.throw);
is.nativePromise = (value: unknown): value is Promise<unknown> =>
isObjectOfType<Promise<unknown>>(TypeName.Promise)(value);
@ -153,6 +157,8 @@ is.promise = (value: unknown): value is Promise<unknown> => is.nativePromise(val
is.generatorFunction = isObjectOfType<GeneratorFunction>(TypeName.GeneratorFunction);
is.asyncGeneratorFunction = (value: unknown): value is ((...args: any[]) => Promise<unknown>) => getObjectType(value) === TypeName.AsyncGeneratorFunction;
is.asyncFunction = (value: unknown): value is ((...args: any[]) => Promise<unknown>) => getObjectType(value) === TypeName.AsyncFunction;
// eslint-disable-next-line no-prototype-builtins, @typescript-eslint/ban-types

46
test/test.ts
View file

@ -123,7 +123,8 @@ const types = new Map<string, Test>([
function () {},
() => {},
async function () {},
function * (): unknown {}
function * (): unknown {},
async function * (): unknown {}
],
typename: TypeName.Function
}],
@ -189,6 +190,15 @@ const types = new Map<string, Test>([
],
typename: TypeName.Generator
}],
['asyncGenerator', {
is: is.asyncGenerator,
fixtures: [
(async function * () {
yield 4;
})()
],
typename: TypeName.AsyncGenerator
}],
['generatorFunction', {
is: is.generatorFunction,
fixtures: [
@ -198,6 +208,15 @@ const types = new Map<string, Test>([
],
typename: TypeName.Function
}],
['asyncGeneratorFunction', {
is: is.asyncGeneratorFunction,
fixtures: [
async function * () {
yield 4;
}
],
typename: TypeName.Function
}],
['asyncFunction', {
is: is.asyncFunction,
fixtures: [
@ -513,7 +532,7 @@ test('is.array', t => {
});
test('is.function', t => {
testType(t, 'function', ['generatorFunction', 'asyncFunction', 'boundFunction']);
testType(t, 'function', ['generatorFunction', 'asyncGeneratorFunction', 'asyncFunction', 'boundFunction']);
});
test('is.boundFunction', t => {
@ -572,10 +591,33 @@ test('is.generator', t => {
testType(t, 'generator');
});
test('is.asyncGenerator', t => {
testType(t, 'asyncGenerator');
const fixture = (async function * () {
yield 4;
})();
if (is.asyncGenerator(fixture)) {
t.true(is.function_(fixture.next));
}
});
test('is.generatorFunction', t => {
testType(t, 'generatorFunction', ['function']);
});
test('is.asyncGeneratorFunction', t => {
testType(t, 'asyncGeneratorFunction', ['function']);
const fixture = async function * () {
yield 4;
};
if (is.asyncGeneratorFunction(fixture)) {
t.true(is.function_(fixture().next));
}
});
test('is.map', t => {
testType(t, 'map', ['emptyMap']);
});