@knodes/typedoc-pluginutils/src/options/option.spec.ts

A set of utilities for TypeDoc plugins

import { expectTypeOf } from 'expect-type';
import {
	ArrayDeclarationOption as ArrDec,
	FlagsDeclarationOption as FlagsDec,
	MapDeclarationOption as MapDec,
	NumberDeclarationOption as NumDec,
	ParameterType as PType,
	ParameterType,
	StringDeclarationOption as StrDec,
} from 'typedoc';

import { InferDeclarationType, MapperPart, Option } from './option';

describe( 'Typings', () => {
	const maybe = true as boolean;
	it( 'should infer declaration', () => {
		if( maybe ) return;
		expectTypeOf<InferDeclarationType<number>>().toEqualTypeOf<NumDec>();
		expectTypeOf<InferDeclarationType<string>>().toEqualTypeOf<StrDec & {type: PType.String | PType.Path}>();
		expectTypeOf<InferDeclarationType<string[]>>().toEqualTypeOf<ArrDec>();
	} );
	it( 'should have correct options values', () => {
		if( maybe ) return;
		const opt1 = Option.factory<number>( {} as any )( {
			name: 'Hello',
			type: ParameterType.Number,
			help: 'Test',
		} );
		expectTypeOf( opt1.getValue() ).toEqualTypeOf<number>();
		expectTypeOf( opt1.setValue ).parameter( 0 ).toEqualTypeOf<number>();
		expectTypeOf( opt1.getValue() ).not.toEqualTypeOf<string>();
		expectTypeOf( opt1.setValue ).parameter( 0 ).not.toEqualTypeOf<string>();

		const opt2 = Option.factory<number>( {} as any )( {
			name: 'Hello',
			type: ParameterType.String,
			help: 'Test',
		}, v => parseInt( v, 10 ) );
		expectTypeOf( opt2.getValue() ).toEqualTypeOf<number>();
		expectTypeOf( opt2.setValue ).parameter( 0 ).toEqualTypeOf<string>();
		expectTypeOf( opt2.getValue() ).not.toEqualTypeOf<string>();
		expectTypeOf( opt2.setValue ).parameter( 0 ).not.toEqualTypeOf<number>();
	} );
	it( 'should infer mapper', () => {
		if( maybe ) return;
		expectTypeOf<MapperPart<number, NumDec>>().toEqualTypeOf<[mapper?: ( value: number ) => number]>();
		expectTypeOf<MapperPart<number, NumDec>>().not.toEqualTypeOf<[mapper: ( value: number ) => number]>();
		expectTypeOf<MapperPart<number, StrDec>>().toEqualTypeOf<[mapper: ( value: string ) => number]>();
		expectTypeOf<MapperPart<{foo: true}, MapDec<{foo: true}>>>().toEqualTypeOf<[mapper?: ( value: {foo: true} ) => {foo: true}]>();
		expectTypeOf<MapperPart<{foo: true}, MapDec<{foo: true}>>>().not.toEqualTypeOf<[mapper: ( value: {foo: true} ) => {foo: true}]>();
		expectTypeOf<MapperPart<{foo: boolean}, FlagsDec<{foo: boolean}>>>().toEqualTypeOf<[mapper?: ( value: {foo: boolean} ) => {foo: boolean}]>();
		expectTypeOf<MapperPart<{foo: boolean}, FlagsDec<{foo: boolean}>>>().not.toEqualTypeOf<[mapper: ( value: {foo: boolean} ) => {foo: boolean}]>();
	} );
} );