Skip to main content
Module

x/scaffold/src/deps/types.ts>ConditionalPick

scaffold your next project with style and 💗
ifiokjr/scaffold
Latest
type alias ConditionalPick
import { type ConditionalPick } from "https://deno.land/x/scaffold@0.3.0/src/deps/types.ts";

Pick keys from the shape that matches the given Condition.

This is useful when you want to create a new type from a specific subset of an existing type. For example, you might want to pick all the primitive properties from a class and form a new automatically derived type.

Examples

Example 1

import type {Primitive, ConditionalPick} from 'type-fest';

class Awesome {
	name: string;
	successes: number;
	failures: bigint;

	run() {}
}

type PickPrimitivesFromAwesome = ConditionalPick<Awesome, Primitive>;
//=> {name: string; successes: number; failures: bigint}

Example 2

import type {ConditionalPick} from 'type-fest';

interface Example {
	a: string;
	b: string | number;
	c: () => void;
	d: {};
}

type StringKeysOnly = ConditionalPick<Example, string>;
//=> {a: string}

Type Parameters

Base
Condition
definition: Pick<Base, ConditionalKeys<Base, Condition>>