Skip to main content
Module

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

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

Exclude keys from a shape that matches the given Condition.

This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.

Examples

Example 1

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

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

	run() {}
}

type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
//=> {run: () => void}

Example 2

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

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

type NonStringKeysOnly = ConditionalExcept<Example, string>;
//=> {b: string | number; c: () => void; d: {}}

Type Parameters

Base
Condition