Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating defaultTo type definitions #30

Merged
merged 6 commits into from
May 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions test/defaultTo.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import { expectType } from 'tsd';
import { defaultTo, __ } from '../es';

expectType<'fallback'>(defaultTo('fallback', undefined));
expectType<'fallback'>(defaultTo('fallback', null));
expectType<string>(defaultTo('fallback')(undefined));
expectType<string>(defaultTo('fallback')(null));
expectType<'fallback'>(defaultTo(__, undefined)('fallback'));
expectType<'fallback'>(defaultTo(__, null)('fallback'));

expectType<'string value'>(defaultTo('fallback', 'string value'));
expectType<'string value'>(defaultTo('fallback')('string value'));

expectType<0>(defaultTo(0, undefined));
expectType<0>(defaultTo(0, null));
expectType<number>(defaultTo(0)(undefined));
expectType<number>(defaultTo(0)(null));
expectType<0>(defaultTo(__, undefined)(0));
expectType<0>(defaultTo(__, null)(0));

expectType<2>(defaultTo(0, 2));
expectType<2>(defaultTo(0)(2));
expectType<number>(defaultTo(__, 2)(0));

expectType<'two'>(defaultTo(0, 'two'));
expectType<'two'>(defaultTo(0)('two'));
expectType<string>(defaultTo(__, 'two')(0));
expectType<2>(defaultTo('zero', 2));
expectType<2>(defaultTo('zero')(2));
expectType<number>(defaultTo(__, 2)('zero'));

const stringOrUndefined = Math.random() < 0.5 ? Math.random().toString(32) : undefined;
expectType<0 | string>(defaultTo(0, stringOrUndefined));
expectType<number | string>(defaultTo(0)(stringOrUndefined));
expectType<0 | string>(defaultTo(__, stringOrUndefined)(0));
const stringOrNull = Math.random() < 0.5 ? Math.random().toString(32) : null;
expectType<0 | string>(defaultTo(0, stringOrNull));
expectType<number | string>(defaultTo(0)(stringOrNull));
expectType<0 | string>(defaultTo(__, stringOrNull)(0));


const numberOrUndefined = Math.random() < 0.5 ? Math.random() : undefined;
expectType<'fallback' | number>(defaultTo('fallback', numberOrUndefined));
expectType<string | number>(defaultTo('fallback')(numberOrUndefined));
expectType<'fallback' | number>(defaultTo(__, numberOrUndefined)('fallback'));
const numberOrNull = Math.random() < 0.5 ? Math.random() : null;
expectType<'fallback' | number>(defaultTo('fallback', numberOrNull));
expectType<string | number>(defaultTo('fallback')(numberOrNull));
expectType<'fallback' | number>(defaultTo(__, numberOrNull)('fallback'));
7 changes: 5 additions & 2 deletions types/defaultTo.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
export function defaultTo<T, U>(a: T, b: U | null | undefined): T | U;
export function defaultTo<T>(a: T): <U>(b: U | null | undefined) => T | U;
import { DefaultTo, Placeholder } from './util/tools';

export function defaultTo<Fallback>(a: Fallback): <Value>(b: Value) => DefaultTo<Fallback, Value>;
lax4mike marked this conversation as resolved.
Show resolved Hide resolved
export function defaultTo<Value>(__: Placeholder, b: Value): <Fallback>(a: Fallback) => DefaultTo<Fallback, Value>;
export function defaultTo<Fallback, Value>(a: Fallback, b: Value): DefaultTo<Fallback, Value>;
6 changes: 6 additions & 0 deletions types/util/tools.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ export type CondPair<T extends any[], R> = [(...val: T) => boolean, (...val: T)
*/
export type CondPairTypeguard<T, TFiltered extends T, R> = [(value: T) => value is TFiltered, (value: TFiltered) => R];

/**
* A conditional type to use with default values. (defaultTo, propOr, etc)
* <created by @lax4mike>
*/
export type DefaultTo<Fallback, Value> = (Value extends (null | undefined) ? Fallback | Exclude<Value, null | undefined> : Value);

/**
* Represents all objects evolvable with Evolver E
* @param E
Expand Down