Sha256: f1a5a12e04ad1471647484e7ff11e36eef7960f54740f2e60e17799d99d6f5ab
Contents?: true
Size: 903 Bytes
Versions: 28
Compression:
Stored size: 903 Bytes
Contents
import type {RequireExactlyOne} from './require-exactly-one';
import type {RequireNone} from './internal';
/**
Create a type that requires exactly one of the given keys and disallows more, or none of the given keys. The remaining keys are kept as is.
@example
```
import type {RequireOneOrNone} from 'type-fest';
type Responder = RequireOneOrNone<{
text: () => string;
json: () => string;
secure: boolean;
}, 'text' | 'json'>;
const responder1: Responder = {
secure: true
};
const responder2: Responder = {
text: () => '{"message": "hi"}',
secure: true
};
const responder3: Responder = {
json: () => '{"message": "ok"}',
secure: true
};
```
@category Object
*/
export type RequireOneOrNone<ObjectType, KeysType extends keyof ObjectType = keyof ObjectType> = (
| RequireExactlyOne<ObjectType, KeysType>
| RequireNone<KeysType>
) & Omit<ObjectType, KeysType>; // Ignore unspecified keys.
Version data entries
28 entries across 28 versions & 2 rubygems