UNPKG

@storm-stack/types

Version:

⚡ The storm-stack monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.

stormsoftware.com

36 lines (35 loc) • 1.1 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
import { DeepKey } from "../utility-types/object"; /** * Checks if a given key is a deep key. * * A deep key is a string that contains a dot (.) or square brackets with a property accessor. * * @example * isDeepKey('a.b') // true * isDeepKey('a[b]') // true * isDeepKey('a') // false * isDeepKey(123) // false * isDeepKey('a.b.c') // true * isDeepKey('a[b][c]') // true * * @param key - The key to check. * @returns Returns true if the key is a deep key, otherwise false. */ export declare function isDeepKey(key: PropertyKey): key is DeepKey<any>; /** * Checks if a given key is a deep key or normal (shallow key). * * A deep key is a string that contains a dot (.) or square brackets with a property accessor. * * @example * isDeepKey('a.b') // true * isDeepKey('a[b]') // true * isDeepKey('a') // true * isDeepKey(123) // false * isDeepKey('a.b.c') // true * isDeepKey('a[b][c]') // true * * @param key - The key to check. * @returns Returns true if the key is a deep key, otherwise false. */ export declare function isKeyOrDeepKey(key: PropertyKey): key is DeepKey<any>;