guardObjectSomeKeys()

guardObjectSomeKeys()

Guards the value to be an object of a generic type variable Obj with some of its keys or some groups of its keys. The function uses isObjectSomeKeys() to search for the keys.

guard-object-some-keys.func.ts

const guardObjectSomeKeys = <
  Obj extends object,
  Payload extends object = object
>(
  value: Obj,
  keys: (keyof Obj | Array<keyof Obj>)[],
  callback?: ResultCallback<Obj, { keys: typeof keys } & Payload>,
  payload?: Payload
): value is Obj => isObjectSomeKeys(value, keys, callback, payload as any);

Generic type variables

Objextendsobject

A generic type variable Obj constrained by object indicates captured object type of the given value via the return type and the value parameter of the provided callback function ResultCallback type.

Payloadextendsobject=object

The Payload generic type variable constrained by object indicates the type of optional parameter payload of the supplied callback function and payload optional parameter of the guardObjectSomeKeys() function from which it captures its value.

Parameters

value: Obj

An object of a generic type variable Obj, by default of the type captured from itself that contains some or some of the groups of the given keys, to guard.

keys: (keyof Obj | Array)[]

An Array of property names or a two-dimensional array of property names to check if the given value contains some of them.

callback?: ResultCallback<Obj, { keys: typeof keys } & Payload>

The optional callback function of ResultCallback type with parameters, the value that has been checked, the result of this check, and payload of generic type variable Payload with optional properties from the provided payload, to handle them before the result return. By default, it uses resultCallback() function.

The payload parameter of the callback function consists of the keys property given in the keys parameter, and it can't be overwritten by the given payload parameter of the main function.

payload?: Payload

An optional object of the generic type variable Payload is assigned to the payload of the given callback function.

Return type

value isObj

The return type is a boolean as the result of its statement indicating the value is an object of a generic type variable Obj, by default of type captured from the supplied value.

Returns

The return value is a boolean indicating whether the value is an object with some or some groups of the given keys.

Example usage

// Example usage.
import { guardObjectSomeKeys } from '@angular-package/type';

const NUMBER = 10304050;
const STRING = '!@#$%^&*()abcdefghijklmnoprstuwyz';
const SYMBOL_NUMBER: unique symbol = Symbol(NUMBER);

interface ObjectOne {
  1030405027?: string;
  [NUMBER]: number;
  [STRING]: string;
  [SYMBOL_NUMBER]?: string;
}
const OBJECT_ONE: ObjectOne = {
  1030405027: 'key is number',
  [STRING]: 'key is string',
  [SYMBOL_NUMBER]: 'key is symbol number',
  get [NUMBER](): number {
    return NUMBER;
  },
};

guardObjectSomeKeys(OBJECT_ONE, [NUMBER, STRING]), // true, value is ObjectOne
guardObjectSomeKeys(OBJECT_ONE, ['no property' as any, STRING]), // true, value is ObjectOne
guardObjectSomeKeys(OBJECT_ONE, ['no property', 2 as any ]), // false, value is ObjectOne
guardObjectSomeKeys(OBJECT_ONE, [['no property'], [2 as any] ]), // false, value is ObjectOne
guardObjectSomeKeys(OBJECT_ONE, [
  [1030405027, NUMBER], // Or
  [1030405027, STRING], // Or
  [1030405027, SYMBOL_NUMBER]
]); // true, value is ObjectOne