npm - yummies - Versions diffs - 7.12.0 → 7.13.0 - Mend

yummies 7.12.0 → 7.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (122) hide show

package/storage.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"storage.cjs","names":[],"sources":["../src/storage.ts"],"sourcesContent":["~~export~~ type StorageType = 'session' \| 'local';\n\nconst storages: Record<StorageType, Storage> = {\n session: sessionStorage,\n local: localStorage,\n};\n\n/*\n Builds a storage key from a prefix, optional namespace and key.\n \n @example\n * ```ts\n * createKey('app', 'token', 'auth'); // 'app/auth/token'\n * ```\n /\nexport const createKey = (prefix: string, key: string, namespace?: string) =>\n `${prefix}${namespace ? `/${namespace}` : ''}/${key}`;\n\nconst parseStorageValue = <V>(value: unknown): V \| null => {\n if (typeof value !== 'string') {\n return value as V;\n }\n\n try {\n const parsed = JSON.parse(value);\n return parsed;\n } catch {\n return null;\n }\n};\n\nconst formatValueToStorage = (value: unknown): string => {\n return JSON.stringify(value);\n};\n\nexport interface SetToStorageConfig<V>\n extends Omit<GetFromStorageConfig<V>, 'fallback'> {\n value: V;\n}\n\nexport interface UnsetFromStorageConfig\n extends Omit<GetFromStorageConfig<any>, 'fallback'> {}\n\nexport interface GetFromStorageConfig<V> {\n /\n Storage key used to retrieve the value.\n * The full key is extended with the project namespace.\n /\n key: string;\n /\n Storage type.\n /\n type: StorageType;\n /\n Default value used when there is no value in storage.\n /\n fallback?: V;\n /\n Optional namespace segment used in the generated key.\n /\n namespace?: string;\n /\n Optional key prefix.\n /\n prefix?: string;\n}\n\nexport type SetToStorageWrappedConfig<\n V,\n BaseConfig extends StorageConfigBase,\n> = Omit<\n SetToStorageConfig<V>,\n Extract<keyof SetToStorageConfig<V>, keyof BaseConfig>\n> &\n Partial<\n Pick<\n SetToStorageConfig<V>,\n Extract<keyof SetToStorageConfig<V>, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof SetToStorageConfig<V>>>;\n\nexport type UnsetFromStorageWrappedConfig<\n BaseConfig extends StorageConfigBase,\n> = Omit<\n UnsetFromStorageConfig,\n Extract<keyof UnsetFromStorageConfig, keyof BaseConfig>\n> &\n Partial<\n Pick<\n UnsetFromStorageConfig,\n Extract<keyof UnsetFromStorageConfig, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof UnsetFromStorageConfig>>;\n\nexport type GetFromStorageWrappedConfig<\n V,\n BaseConfig extends StorageConfigBase,\n> = Omit<\n GetFromStorageConfig<V>,\n Extract<keyof GetFromStorageConfig<V>, keyof BaseConfig>\n> &\n Partial<\n Pick<\n GetFromStorageConfig<V>,\n Extract<keyof GetFromStorageConfig<V>, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof GetFromStorageConfig<V>>>;\n\nexport type StorageConfigBase = Partial<\n Pick<GetFromStorageConfig<any>, 'prefix' \| 'type'>\n>;\n\nexport interface StorageApi<BaseConfig extends StorageConfigBase> {\n set<Value>(config: SetToStorageWrappedConfig<Value, BaseConfig>): void;\n unset(config: UnsetFromStorageWrappedConfig<BaseConfig>): void;\n get<Value>(\n config: GetFromStorageWrappedConfig<Value, BaseConfig>,\n ): Value \| null;\n}\n\n/\n Creates an interface for working with storage (`localStorage`, `sessionStorage`).\n */\nexport function createStorage<BaseConfig extends StorageConfigBase>(\n storageConfig: BaseConfig,\n): StorageApi<BaseConfig> {\n return {\n set: <Value>(cfg: SetToStorageWrappedConfig<Value, BaseConfig>) => {\n const config = cfg as unknown as SetToStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n\n const storage = storages[storageType];\n\n storage.setItem(\n createKey(storagePrefix, config.key, config.namespace),\n formatValueToStorage(config.value),\n );\n },\n unset: <Value>(cfg: UnsetFromStorageWrappedConfig<BaseConfig>) => {\n const config = cfg as unknown as SetToStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n const storage = storages[storageType];\n\n storage.removeItem(\n createKey(storagePrefix, config.key, config.namespace),\n );\n },\n get: <Value>(cfg: GetFromStorageWrappedConfig<Value, BaseConfig>) => {\n const config = cfg as unknown as GetFromStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n\n const storage = storages[storageType];\n\n return (\n parseStorageValue<Value>(\n storage.getItem(\n createKey(storagePrefix, config.key, config.namespace),\n ),\n ) ??\n config.fallback ??\n null\n );\n },\n } as const;\n}\n"],"mappings":";;~~AAEA~~,IAAM,WAAyC;CAC7C,SAAS;CACT,OAAO;CACR;;;;;;;;;AAUD,IAAa,aAAa,QAAgB,KAAa,cACrD,GAAG,SAAS,YAAY,IAAI,cAAc,GAAG,GAAG;AAElD,IAAM,qBAAwB,UAA6B;AACzD,KAAI,OAAO,UAAU,SACnB,QAAO;AAGT,KAAI;AAEF,SADe,KAAK,MAAM,MAAM;SAE1B;AACN,SAAO;;;AAIX,IAAM,wBAAwB,UAA2B;AACvD,QAAO,KAAK,UAAU,MAAM;;;;;AA8F9B,SAAgB,cACd,eACwB;AACxB,QAAO;EACL,MAAa,QAAsD;GACjE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;AAEtC,YAAS,aAEjB,QACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,EACtD,qBAAqB,OAAO,MAAM,CACnC;;EAEH,QAAe,QAAmD;GAChE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;AACtC,YAAS,aAEjB,WACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,CACvD;;EAEH,MAAa,QAAwD;GACnE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;GAEtD,MAAM,UAAU,SAAS;AAEzB,UACE,kBACE,QAAQ,QACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,CACvD,CACF,IACD,OAAO,YACP;;EAGL"}
1	+ {"version":3,"file":"storage.cjs","names":[],"sources":["../src/storage.ts"],"sourcesContent":["/*\n ---header-docs-section---\n * # yummies/storage\n \n ## Description\n \n Typed helpers around `sessionStorage` and `localStorage`: key namespacing, JSON parse\n * safety, and small wrappers that avoid repeating `try/catch` around `getItem`/`setItem`. Use it when\n * you need durable client state with predictable serialization, not a full offline database.\n \n ## Usage\n \n ```ts\n * import { createKey } from \"yummies/storage\";\n * ```\n /\n\nexport type StorageType = 'session' \| 'local';\n\nconst storages: Record<StorageType, Storage> = {\n session: sessionStorage,\n local: localStorage,\n};\n\n/\n Builds a storage key from a prefix, optional namespace and key.\n \n @example\n * ```ts\n * createKey('app', 'token', 'auth'); // 'app/auth/token'\n * ```\n /\nexport const createKey = (prefix: string, key: string, namespace?: string) =>\n `${prefix}${namespace ? `/${namespace}` : ''}/${key}`;\n\nconst parseStorageValue = <V>(value: unknown): V \| null => {\n if (typeof value !== 'string') {\n return value as V;\n }\n\n try {\n const parsed = JSON.parse(value);\n return parsed;\n } catch {\n return null;\n }\n};\n\nconst formatValueToStorage = (value: unknown): string => {\n return JSON.stringify(value);\n};\n\nexport interface SetToStorageConfig<V>\n extends Omit<GetFromStorageConfig<V>, 'fallback'> {\n value: V;\n}\n\nexport interface UnsetFromStorageConfig\n extends Omit<GetFromStorageConfig<any>, 'fallback'> {}\n\nexport interface GetFromStorageConfig<V> {\n /\n Storage key used to retrieve the value.\n * The full key is extended with the project namespace.\n /\n key: string;\n /\n Storage type.\n /\n type: StorageType;\n /\n Default value used when there is no value in storage.\n /\n fallback?: V;\n /\n Optional namespace segment used in the generated key.\n /\n namespace?: string;\n /\n Optional key prefix.\n /\n prefix?: string;\n}\n\nexport type SetToStorageWrappedConfig<\n V,\n BaseConfig extends StorageConfigBase,\n> = Omit<\n SetToStorageConfig<V>,\n Extract<keyof SetToStorageConfig<V>, keyof BaseConfig>\n> &\n Partial<\n Pick<\n SetToStorageConfig<V>,\n Extract<keyof SetToStorageConfig<V>, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof SetToStorageConfig<V>>>;\n\nexport type UnsetFromStorageWrappedConfig<\n BaseConfig extends StorageConfigBase,\n> = Omit<\n UnsetFromStorageConfig,\n Extract<keyof UnsetFromStorageConfig, keyof BaseConfig>\n> &\n Partial<\n Pick<\n UnsetFromStorageConfig,\n Extract<keyof UnsetFromStorageConfig, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof UnsetFromStorageConfig>>;\n\nexport type GetFromStorageWrappedConfig<\n V,\n BaseConfig extends StorageConfigBase,\n> = Omit<\n GetFromStorageConfig<V>,\n Extract<keyof GetFromStorageConfig<V>, keyof BaseConfig>\n> &\n Partial<\n Pick<\n GetFromStorageConfig<V>,\n Extract<keyof GetFromStorageConfig<V>, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof GetFromStorageConfig<V>>>;\n\nexport type StorageConfigBase = Partial<\n Pick<GetFromStorageConfig<any>, 'prefix' \| 'type'>\n>;\n\nexport interface StorageApi<BaseConfig extends StorageConfigBase> {\n set<Value>(config: SetToStorageWrappedConfig<Value, BaseConfig>): void;\n unset(config: UnsetFromStorageWrappedConfig<BaseConfig>): void;\n get<Value>(\n config: GetFromStorageWrappedConfig<Value, BaseConfig>,\n ): Value \| null;\n}\n\n/\n Creates an interface for working with storage (`localStorage`, `sessionStorage`).\n */\nexport function createStorage<BaseConfig extends StorageConfigBase>(\n storageConfig: BaseConfig,\n): StorageApi<BaseConfig> {\n return {\n set: <Value>(cfg: SetToStorageWrappedConfig<Value, BaseConfig>) => {\n const config = cfg as unknown as SetToStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n\n const storage = storages[storageType];\n\n storage.setItem(\n createKey(storagePrefix, config.key, config.namespace),\n formatValueToStorage(config.value),\n );\n },\n unset: <Value>(cfg: UnsetFromStorageWrappedConfig<BaseConfig>) => {\n const config = cfg as unknown as SetToStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n const storage = storages[storageType];\n\n storage.removeItem(\n createKey(storagePrefix, config.key, config.namespace),\n );\n },\n get: <Value>(cfg: GetFromStorageWrappedConfig<Value, BaseConfig>) => {\n const config = cfg as unknown as GetFromStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n\n const storage = storages[storageType];\n\n return (\n parseStorageValue<Value>(\n storage.getItem(\n createKey(storagePrefix, config.key, config.namespace),\n ),\n ) ??\n config.fallback ??\n null\n );\n },\n } as const;\n}\n"],"mappings":";;AAmBA,IAAM,WAAyC;CAC7C,SAAS;CACT,OAAO;CACR;;;;;;;;;AAUD,IAAa,aAAa,QAAgB,KAAa,cACrD,GAAG,SAAS,YAAY,IAAI,cAAc,GAAG,GAAG;AAElD,IAAM,qBAAwB,UAA6B;AACzD,KAAI,OAAO,UAAU,SACnB,QAAO;AAGT,KAAI;AAEF,SADe,KAAK,MAAM,MAAM;SAE1B;AACN,SAAO;;;AAIX,IAAM,wBAAwB,UAA2B;AACvD,QAAO,KAAK,UAAU,MAAM;;;;;AA8F9B,SAAgB,cACd,eACwB;AACxB,QAAO;EACL,MAAa,QAAsD;GACjE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;AAEtC,YAAS,aAEjB,QACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,EACtD,qBAAqB,OAAO,MAAM,CACnC;;EAEH,QAAe,QAAmD;GAChE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;AACtC,YAAS,aAEjB,WACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,CACvD;;EAEH,MAAa,QAAwD;GACnE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;GAEtD,MAAM,UAAU,SAAS;AAEzB,UACE,kBACE,QAAQ,QACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,CACvD,CACF,IACD,OAAO,YACP;;EAGL"}

package/storage.d.ts CHANGED Viewed

@@ -1,3 +1,19 @@
+/**
+ * ---header-docs-section---
+ * # yummies/storage
+ *
+ * ## Description
+ *
+ * Typed helpers around **`sessionStorage`** and **`localStorage`**: key namespacing, JSON parse
+ * safety, and small wrappers that avoid repeating `try/catch` around `getItem`/`setItem`. Use it when
+ * you need durable client state with predictable serialization, not a full offline database.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { createKey } from "yummies/storage";
+ * ```
+ */
 type StorageType = 'session' | 'local';
 /**
  * Builds a storage key from a prefix, optional namespace and key.

package/storage.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"storage.js","names":[],"sources":["../src/storage.ts"],"sourcesContent":["~~export~~ type StorageType = 'session' \| 'local';\n\nconst storages: Record<StorageType, Storage> = {\n session: sessionStorage,\n local: localStorage,\n};\n\n/*\n Builds a storage key from a prefix, optional namespace and key.\n \n @example\n * ```ts\n * createKey('app', 'token', 'auth'); // 'app/auth/token'\n * ```\n /\nexport const createKey = (prefix: string, key: string, namespace?: string) =>\n `${prefix}${namespace ? `/${namespace}` : ''}/${key}`;\n\nconst parseStorageValue = <V>(value: unknown): V \| null => {\n if (typeof value !== 'string') {\n return value as V;\n }\n\n try {\n const parsed = JSON.parse(value);\n return parsed;\n } catch {\n return null;\n }\n};\n\nconst formatValueToStorage = (value: unknown): string => {\n return JSON.stringify(value);\n};\n\nexport interface SetToStorageConfig<V>\n extends Omit<GetFromStorageConfig<V>, 'fallback'> {\n value: V;\n}\n\nexport interface UnsetFromStorageConfig\n extends Omit<GetFromStorageConfig<any>, 'fallback'> {}\n\nexport interface GetFromStorageConfig<V> {\n /\n Storage key used to retrieve the value.\n * The full key is extended with the project namespace.\n /\n key: string;\n /\n Storage type.\n /\n type: StorageType;\n /\n Default value used when there is no value in storage.\n /\n fallback?: V;\n /\n Optional namespace segment used in the generated key.\n /\n namespace?: string;\n /\n Optional key prefix.\n /\n prefix?: string;\n}\n\nexport type SetToStorageWrappedConfig<\n V,\n BaseConfig extends StorageConfigBase,\n> = Omit<\n SetToStorageConfig<V>,\n Extract<keyof SetToStorageConfig<V>, keyof BaseConfig>\n> &\n Partial<\n Pick<\n SetToStorageConfig<V>,\n Extract<keyof SetToStorageConfig<V>, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof SetToStorageConfig<V>>>;\n\nexport type UnsetFromStorageWrappedConfig<\n BaseConfig extends StorageConfigBase,\n> = Omit<\n UnsetFromStorageConfig,\n Extract<keyof UnsetFromStorageConfig, keyof BaseConfig>\n> &\n Partial<\n Pick<\n UnsetFromStorageConfig,\n Extract<keyof UnsetFromStorageConfig, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof UnsetFromStorageConfig>>;\n\nexport type GetFromStorageWrappedConfig<\n V,\n BaseConfig extends StorageConfigBase,\n> = Omit<\n GetFromStorageConfig<V>,\n Extract<keyof GetFromStorageConfig<V>, keyof BaseConfig>\n> &\n Partial<\n Pick<\n GetFromStorageConfig<V>,\n Extract<keyof GetFromStorageConfig<V>, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof GetFromStorageConfig<V>>>;\n\nexport type StorageConfigBase = Partial<\n Pick<GetFromStorageConfig<any>, 'prefix' \| 'type'>\n>;\n\nexport interface StorageApi<BaseConfig extends StorageConfigBase> {\n set<Value>(config: SetToStorageWrappedConfig<Value, BaseConfig>): void;\n unset(config: UnsetFromStorageWrappedConfig<BaseConfig>): void;\n get<Value>(\n config: GetFromStorageWrappedConfig<Value, BaseConfig>,\n ): Value \| null;\n}\n\n/\n Creates an interface for working with storage (`localStorage`, `sessionStorage`).\n */\nexport function createStorage<BaseConfig extends StorageConfigBase>(\n storageConfig: BaseConfig,\n): StorageApi<BaseConfig> {\n return {\n set: <Value>(cfg: SetToStorageWrappedConfig<Value, BaseConfig>) => {\n const config = cfg as unknown as SetToStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n\n const storage = storages[storageType];\n\n storage.setItem(\n createKey(storagePrefix, config.key, config.namespace),\n formatValueToStorage(config.value),\n );\n },\n unset: <Value>(cfg: UnsetFromStorageWrappedConfig<BaseConfig>) => {\n const config = cfg as unknown as SetToStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n const storage = storages[storageType];\n\n storage.removeItem(\n createKey(storagePrefix, config.key, config.namespace),\n );\n },\n get: <Value>(cfg: GetFromStorageWrappedConfig<Value, BaseConfig>) => {\n const config = cfg as unknown as GetFromStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n\n const storage = storages[storageType];\n\n return (\n parseStorageValue<Value>(\n storage.getItem(\n createKey(storagePrefix, config.key, config.namespace),\n ),\n ) ??\n config.fallback ??\n null\n );\n },\n } as const;\n}\n"],"mappings":";~~AAEA~~,IAAM,WAAyC;CAC7C,SAAS;CACT,OAAO;CACR;;;;;;;;;AAUD,IAAa,aAAa,QAAgB,KAAa,cACrD,GAAG,SAAS,YAAY,IAAI,cAAc,GAAG,GAAG;AAElD,IAAM,qBAAwB,UAA6B;AACzD,KAAI,OAAO,UAAU,SACnB,QAAO;AAGT,KAAI;AAEF,SADe,KAAK,MAAM,MAAM;SAE1B;AACN,SAAO;;;AAIX,IAAM,wBAAwB,UAA2B;AACvD,QAAO,KAAK,UAAU,MAAM;;;;;AA8F9B,SAAgB,cACd,eACwB;AACxB,QAAO;EACL,MAAa,QAAsD;GACjE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;AAEtC,YAAS,aAEjB,QACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,EACtD,qBAAqB,OAAO,MAAM,CACnC;;EAEH,QAAe,QAAmD;GAChE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;AACtC,YAAS,aAEjB,WACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,CACvD;;EAEH,MAAa,QAAwD;GACnE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;GAEtD,MAAM,UAAU,SAAS;AAEzB,UACE,kBACE,QAAQ,QACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,CACvD,CACF,IACD,OAAO,YACP;;EAGL"}
1	+ {"version":3,"file":"storage.js","names":[],"sources":["../src/storage.ts"],"sourcesContent":["/*\n ---header-docs-section---\n * # yummies/storage\n \n ## Description\n \n Typed helpers around `sessionStorage` and `localStorage`: key namespacing, JSON parse\n * safety, and small wrappers that avoid repeating `try/catch` around `getItem`/`setItem`. Use it when\n * you need durable client state with predictable serialization, not a full offline database.\n \n ## Usage\n \n ```ts\n * import { createKey } from \"yummies/storage\";\n * ```\n /\n\nexport type StorageType = 'session' \| 'local';\n\nconst storages: Record<StorageType, Storage> = {\n session: sessionStorage,\n local: localStorage,\n};\n\n/\n Builds a storage key from a prefix, optional namespace and key.\n \n @example\n * ```ts\n * createKey('app', 'token', 'auth'); // 'app/auth/token'\n * ```\n /\nexport const createKey = (prefix: string, key: string, namespace?: string) =>\n `${prefix}${namespace ? `/${namespace}` : ''}/${key}`;\n\nconst parseStorageValue = <V>(value: unknown): V \| null => {\n if (typeof value !== 'string') {\n return value as V;\n }\n\n try {\n const parsed = JSON.parse(value);\n return parsed;\n } catch {\n return null;\n }\n};\n\nconst formatValueToStorage = (value: unknown): string => {\n return JSON.stringify(value);\n};\n\nexport interface SetToStorageConfig<V>\n extends Omit<GetFromStorageConfig<V>, 'fallback'> {\n value: V;\n}\n\nexport interface UnsetFromStorageConfig\n extends Omit<GetFromStorageConfig<any>, 'fallback'> {}\n\nexport interface GetFromStorageConfig<V> {\n /\n Storage key used to retrieve the value.\n * The full key is extended with the project namespace.\n /\n key: string;\n /\n Storage type.\n /\n type: StorageType;\n /\n Default value used when there is no value in storage.\n /\n fallback?: V;\n /\n Optional namespace segment used in the generated key.\n /\n namespace?: string;\n /\n Optional key prefix.\n /\n prefix?: string;\n}\n\nexport type SetToStorageWrappedConfig<\n V,\n BaseConfig extends StorageConfigBase,\n> = Omit<\n SetToStorageConfig<V>,\n Extract<keyof SetToStorageConfig<V>, keyof BaseConfig>\n> &\n Partial<\n Pick<\n SetToStorageConfig<V>,\n Extract<keyof SetToStorageConfig<V>, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof SetToStorageConfig<V>>>;\n\nexport type UnsetFromStorageWrappedConfig<\n BaseConfig extends StorageConfigBase,\n> = Omit<\n UnsetFromStorageConfig,\n Extract<keyof UnsetFromStorageConfig, keyof BaseConfig>\n> &\n Partial<\n Pick<\n UnsetFromStorageConfig,\n Extract<keyof UnsetFromStorageConfig, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof UnsetFromStorageConfig>>;\n\nexport type GetFromStorageWrappedConfig<\n V,\n BaseConfig extends StorageConfigBase,\n> = Omit<\n GetFromStorageConfig<V>,\n Extract<keyof GetFromStorageConfig<V>, keyof BaseConfig>\n> &\n Partial<\n Pick<\n GetFromStorageConfig<V>,\n Extract<keyof GetFromStorageConfig<V>, keyof BaseConfig>\n >\n > &\n Pick<BaseConfig, Exclude<keyof BaseConfig, keyof GetFromStorageConfig<V>>>;\n\nexport type StorageConfigBase = Partial<\n Pick<GetFromStorageConfig<any>, 'prefix' \| 'type'>\n>;\n\nexport interface StorageApi<BaseConfig extends StorageConfigBase> {\n set<Value>(config: SetToStorageWrappedConfig<Value, BaseConfig>): void;\n unset(config: UnsetFromStorageWrappedConfig<BaseConfig>): void;\n get<Value>(\n config: GetFromStorageWrappedConfig<Value, BaseConfig>,\n ): Value \| null;\n}\n\n/\n Creates an interface for working with storage (`localStorage`, `sessionStorage`).\n */\nexport function createStorage<BaseConfig extends StorageConfigBase>(\n storageConfig: BaseConfig,\n): StorageApi<BaseConfig> {\n return {\n set: <Value>(cfg: SetToStorageWrappedConfig<Value, BaseConfig>) => {\n const config = cfg as unknown as SetToStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n\n const storage = storages[storageType];\n\n storage.setItem(\n createKey(storagePrefix, config.key, config.namespace),\n formatValueToStorage(config.value),\n );\n },\n unset: <Value>(cfg: UnsetFromStorageWrappedConfig<BaseConfig>) => {\n const config = cfg as unknown as SetToStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n const storage = storages[storageType];\n\n storage.removeItem(\n createKey(storagePrefix, config.key, config.namespace),\n );\n },\n get: <Value>(cfg: GetFromStorageWrappedConfig<Value, BaseConfig>) => {\n const config = cfg as unknown as GetFromStorageConfig<Value>;\n const storageType = (config.type ?? storageConfig.type!) as StorageType;\n const storagePrefix = (config.prefix ?? storageConfig.prefix!) as string;\n\n const storage = storages[storageType];\n\n return (\n parseStorageValue<Value>(\n storage.getItem(\n createKey(storagePrefix, config.key, config.namespace),\n ),\n ) ??\n config.fallback ??\n null\n );\n },\n } as const;\n}\n"],"mappings":";AAmBA,IAAM,WAAyC;CAC7C,SAAS;CACT,OAAO;CACR;;;;;;;;;AAUD,IAAa,aAAa,QAAgB,KAAa,cACrD,GAAG,SAAS,YAAY,IAAI,cAAc,GAAG,GAAG;AAElD,IAAM,qBAAwB,UAA6B;AACzD,KAAI,OAAO,UAAU,SACnB,QAAO;AAGT,KAAI;AAEF,SADe,KAAK,MAAM,MAAM;SAE1B;AACN,SAAO;;;AAIX,IAAM,wBAAwB,UAA2B;AACvD,QAAO,KAAK,UAAU,MAAM;;;;;AA8F9B,SAAgB,cACd,eACwB;AACxB,QAAO;EACL,MAAa,QAAsD;GACjE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;AAEtC,YAAS,aAEjB,QACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,EACtD,qBAAqB,OAAO,MAAM,CACnC;;EAEH,QAAe,QAAmD;GAChE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;AACtC,YAAS,aAEjB,WACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,CACvD;;EAEH,MAAa,QAAwD;GACnE,MAAM,SAAS;GACf,MAAM,cAAe,OAAO,QAAQ,cAAc;GAClD,MAAM,gBAAiB,OAAO,UAAU,cAAc;GAEtD,MAAM,UAAU,SAAS;AAEzB,UACE,kBACE,QAAQ,QACN,UAAU,eAAe,OAAO,KAAK,OAAO,UAAU,CACvD,CACF,IACD,OAAO,YACP;;EAGL"}

package/text.cjs CHANGED Viewed

@@ -1,6 +1,22 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/text.ts
 /**
+* ---header-docs-section---
+* # yummies/text
+*
+* ## Description
+*
+* Russian-centric text helpers: **declension** by count (одно слово / два слова / пять слов) and
+* utilities for splitting long strings into wrapped lines. Pair with `yummies/date-time` for
+* natural language timestamps and labels in Slavic locales.
+*
+* ## Usage
+*
+* ```ts
+* import { declension } from "yummies/text";
+* ```
+*/
+/**
 * Returns the correct word form based on the provided count.
 * @example
 * declension(1, ['slovo', 'slova', 'slov']) // 'slovo'

package/text.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"text.cjs","names":[],"sources":["../src/text.ts"],"sourcesContent":["/*\n Returns the correct word form based on the provided count.\n * @example\n * declension(1, ['slovo', 'slova', 'slov']) // 'slovo'\n * @example\n * declension(2, ['slovo', 'slova', 'slov']) // 'slova'\n * @example\n * declension(5, ['slovo', 'slova', 'slov']) // 'slov'\n /\nexport const declension = (\n count: number,\n txt: readonly [one: string, two: string, five: string],\n cases = [2, 0, 1, 1, 1, 2],\n) =>\n txt[count % 100 > 4 && count % 100 < 20 ? 2 : cases[Math.min(count % 10, 5)]];\n\n/\n Splits text into lines with a maximum line length.\n */\nexport const splitTextByLines = (\n text: string,\n lineLingth: number = 60,\n): string[] => {\n const words = text.split(/\\s+/).filter((word) => word !== '');\n const lines = [];\n let currentLine = '';\n\n for (const word of words) {\n if (word.length > lineLingth) {\n if (currentLine !== '') {\n lines.push(currentLine);\n currentLine = '';\n }\n\n let start = 0;\n while (start < word.length) {\n const chunk = word.slice(start, start + lineLingth);\n lines.push(chunk);\n start += lineLingth;\n }\n continue;\n }\n\n // Проверка возможности добавления слова в текущую строку\n if (currentLine === '') {\n currentLine = word;\n } else if (currentLine.length + 1 + word.length <= lineLingth) {\n currentLine += ` ${word}`;\n } else {\n lines.push(currentLine);\n currentLine = word;\n }\n }\n\n if (currentLine !== '' \|\| lines.length === 0) {\n lines.push(currentLine);\n }\n\n return lines;\n};\n"],"mappings":"~~;;;;;;;;;;;AASA~~,IAAa,cACX,OACA,KACA,QAAQ;CAAC;CAAG;CAAG;CAAG;CAAG;CAAG;CAAE,KAE1B,IAAI,QAAQ,MAAM,KAAK,QAAQ,MAAM,KAAK,IAAI,MAAM,KAAK,IAAI,QAAQ,IAAI,EAAE;;;;AAK7E,IAAa,oBACX,MACA,aAAqB,OACR;CACb,MAAM,QAAQ,KAAK,MAAM,MAAM,CAAC,QAAQ,SAAS,SAAS,GAAG;CAC7D,MAAM,QAAQ,EAAE;CAChB,IAAI,cAAc;AAElB,MAAK,MAAM,QAAQ,OAAO;AACxB,MAAI,KAAK,SAAS,YAAY;AAC5B,OAAI,gBAAgB,IAAI;AACtB,UAAM,KAAK,YAAY;AACvB,kBAAc;;GAGhB,IAAI,QAAQ;AACZ,UAAO,QAAQ,KAAK,QAAQ;IAC1B,MAAM,QAAQ,KAAK,MAAM,OAAO,QAAQ,WAAW;AACnD,UAAM,KAAK,MAAM;AACjB,aAAS;;AAEX;;AAIF,MAAI,gBAAgB,GAClB,eAAc;WACL,YAAY,SAAS,IAAI,KAAK,UAAU,WACjD,gBAAe,IAAI;OACd;AACL,SAAM,KAAK,YAAY;AACvB,iBAAc;;;AAIlB,KAAI,gBAAgB,MAAM,MAAM,WAAW,EACzC,OAAM,KAAK,YAAY;AAGzB,QAAO"}
1	+ {"version":3,"file":"text.cjs","names":[],"sources":["../src/text.ts"],"sourcesContent":["/*\n ---header-docs-section---\n * # yummies/text\n \n ## Description\n \n Russian-centric text helpers: declension by count (одно слово / два слова / пять слов) and\n * utilities for splitting long strings into wrapped lines. Pair with `yummies/date-time` for\n * natural language timestamps and labels in Slavic locales.\n \n ## Usage\n \n ```ts\n * import { declension } from \"yummies/text\";\n * ```\n /\n\n/\n Returns the correct word form based on the provided count.\n * @example\n * declension(1, ['slovo', 'slova', 'slov']) // 'slovo'\n * @example\n * declension(2, ['slovo', 'slova', 'slov']) // 'slova'\n * @example\n * declension(5, ['slovo', 'slova', 'slov']) // 'slov'\n /\nexport const declension = (\n count: number,\n txt: readonly [one: string, two: string, five: string],\n cases = [2, 0, 1, 1, 1, 2],\n) =>\n txt[count % 100 > 4 && count % 100 < 20 ? 2 : cases[Math.min(count % 10, 5)]];\n\n/\n Splits text into lines with a maximum line length.\n */\nexport const splitTextByLines = (\n text: string,\n lineLingth: number = 60,\n): string[] => {\n const words = text.split(/\\s+/).filter((word) => word !== '');\n const lines = [];\n let currentLine = '';\n\n for (const word of words) {\n if (word.length > lineLingth) {\n if (currentLine !== '') {\n lines.push(currentLine);\n currentLine = '';\n }\n\n let start = 0;\n while (start < word.length) {\n const chunk = word.slice(start, start + lineLingth);\n lines.push(chunk);\n start += lineLingth;\n }\n continue;\n }\n\n // Проверка возможности добавления слова в текущую строку\n if (currentLine === '') {\n currentLine = word;\n } else if (currentLine.length + 1 + word.length <= lineLingth) {\n currentLine += ` ${word}`;\n } else {\n lines.push(currentLine);\n currentLine = word;\n }\n }\n\n if (currentLine !== '' \|\| lines.length === 0) {\n lines.push(currentLine);\n }\n\n return lines;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,IAAa,cACX,OACA,KACA,QAAQ;CAAC;CAAG;CAAG;CAAG;CAAG;CAAG;CAAE,KAE1B,IAAI,QAAQ,MAAM,KAAK,QAAQ,MAAM,KAAK,IAAI,MAAM,KAAK,IAAI,QAAQ,IAAI,EAAE;;;;AAK7E,IAAa,oBACX,MACA,aAAqB,OACR;CACb,MAAM,QAAQ,KAAK,MAAM,MAAM,CAAC,QAAQ,SAAS,SAAS,GAAG;CAC7D,MAAM,QAAQ,EAAE;CAChB,IAAI,cAAc;AAElB,MAAK,MAAM,QAAQ,OAAO;AACxB,MAAI,KAAK,SAAS,YAAY;AAC5B,OAAI,gBAAgB,IAAI;AACtB,UAAM,KAAK,YAAY;AACvB,kBAAc;;GAGhB,IAAI,QAAQ;AACZ,UAAO,QAAQ,KAAK,QAAQ;IAC1B,MAAM,QAAQ,KAAK,MAAM,OAAO,QAAQ,WAAW;AACnD,UAAM,KAAK,MAAM;AACjB,aAAS;;AAEX;;AAIF,MAAI,gBAAgB,GAClB,eAAc;WACL,YAAY,SAAS,IAAI,KAAK,UAAU,WACjD,gBAAe,IAAI;OACd;AACL,SAAM,KAAK,YAAY;AACvB,iBAAc;;;AAIlB,KAAI,gBAAgB,MAAM,MAAM,WAAW,EACzC,OAAM,KAAK,YAAY;AAGzB,QAAO"}

package/text.d.ts CHANGED Viewed

@@ -1,3 +1,19 @@
+/**
+ * ---header-docs-section---
+ * # yummies/text
+ *
+ * ## Description
+ *
+ * Russian-centric text helpers: **declension** by count (одно слово / два слова / пять слов) and
+ * utilities for splitting long strings into wrapped lines. Pair with `yummies/date-time` for
+ * natural language timestamps and labels in Slavic locales.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { declension } from "yummies/text";
+ * ```
+ */
 /**
  * Returns the correct word form based on the provided count.
  * @example

package/text.js CHANGED Viewed

@@ -1,5 +1,21 @@
 //#region src/text.ts
 /**
+* ---header-docs-section---
+* # yummies/text
+*
+* ## Description
+*
+* Russian-centric text helpers: **declension** by count (одно слово / два слова / пять слов) and
+* utilities for splitting long strings into wrapped lines. Pair with `yummies/date-time` for
+* natural language timestamps and labels in Slavic locales.
+*
+* ## Usage
+*
+* ```ts
+* import { declension } from "yummies/text";
+* ```
+*/
+/**
 * Returns the correct word form based on the provided count.
 * @example
 * declension(1, ['slovo', 'slova', 'slov']) // 'slovo'

package/text.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"text.js","names":[],"sources":["../src/text.ts"],"sourcesContent":["/*\n Returns the correct word form based on the provided count.\n * @example\n * declension(1, ['slovo', 'slova', 'slov']) // 'slovo'\n * @example\n * declension(2, ['slovo', 'slova', 'slov']) // 'slova'\n * @example\n * declension(5, ['slovo', 'slova', 'slov']) // 'slov'\n /\nexport const declension = (\n count: number,\n txt: readonly [one: string, two: string, five: string],\n cases = [2, 0, 1, 1, 1, 2],\n) =>\n txt[count % 100 > 4 && count % 100 < 20 ? 2 : cases[Math.min(count % 10, 5)]];\n\n/\n Splits text into lines with a maximum line length.\n */\nexport const splitTextByLines = (\n text: string,\n lineLingth: number = 60,\n): string[] => {\n const words = text.split(/\\s+/).filter((word) => word !== '');\n const lines = [];\n let currentLine = '';\n\n for (const word of words) {\n if (word.length > lineLingth) {\n if (currentLine !== '') {\n lines.push(currentLine);\n currentLine = '';\n }\n\n let start = 0;\n while (start < word.length) {\n const chunk = word.slice(start, start + lineLingth);\n lines.push(chunk);\n start += lineLingth;\n }\n continue;\n }\n\n // Проверка возможности добавления слова в текущую строку\n if (currentLine === '') {\n currentLine = word;\n } else if (currentLine.length + 1 + word.length <= lineLingth) {\n currentLine += ` ${word}`;\n } else {\n lines.push(currentLine);\n currentLine = word;\n }\n }\n\n if (currentLine !== '' \|\| lines.length === 0) {\n lines.push(currentLine);\n }\n\n return lines;\n};\n"],"mappings":"~~;;;;;;;;;;AASA~~,IAAa,cACX,OACA,KACA,QAAQ;CAAC;CAAG;CAAG;CAAG;CAAG;CAAG;CAAE,KAE1B,IAAI,QAAQ,MAAM,KAAK,QAAQ,MAAM,KAAK,IAAI,MAAM,KAAK,IAAI,QAAQ,IAAI,EAAE;;;;AAK7E,IAAa,oBACX,MACA,aAAqB,OACR;CACb,MAAM,QAAQ,KAAK,MAAM,MAAM,CAAC,QAAQ,SAAS,SAAS,GAAG;CAC7D,MAAM,QAAQ,EAAE;CAChB,IAAI,cAAc;AAElB,MAAK,MAAM,QAAQ,OAAO;AACxB,MAAI,KAAK,SAAS,YAAY;AAC5B,OAAI,gBAAgB,IAAI;AACtB,UAAM,KAAK,YAAY;AACvB,kBAAc;;GAGhB,IAAI,QAAQ;AACZ,UAAO,QAAQ,KAAK,QAAQ;IAC1B,MAAM,QAAQ,KAAK,MAAM,OAAO,QAAQ,WAAW;AACnD,UAAM,KAAK,MAAM;AACjB,aAAS;;AAEX;;AAIF,MAAI,gBAAgB,GAClB,eAAc;WACL,YAAY,SAAS,IAAI,KAAK,UAAU,WACjD,gBAAe,IAAI;OACd;AACL,SAAM,KAAK,YAAY;AACvB,iBAAc;;;AAIlB,KAAI,gBAAgB,MAAM,MAAM,WAAW,EACzC,OAAM,KAAK,YAAY;AAGzB,QAAO"}
1	+ {"version":3,"file":"text.js","names":[],"sources":["../src/text.ts"],"sourcesContent":["/*\n ---header-docs-section---\n * # yummies/text\n \n ## Description\n \n Russian-centric text helpers: declension by count (одно слово / два слова / пять слов) and\n * utilities for splitting long strings into wrapped lines. Pair with `yummies/date-time` for\n * natural language timestamps and labels in Slavic locales.\n \n ## Usage\n \n ```ts\n * import { declension } from \"yummies/text\";\n * ```\n /\n\n/\n Returns the correct word form based on the provided count.\n * @example\n * declension(1, ['slovo', 'slova', 'slov']) // 'slovo'\n * @example\n * declension(2, ['slovo', 'slova', 'slov']) // 'slova'\n * @example\n * declension(5, ['slovo', 'slova', 'slov']) // 'slov'\n /\nexport const declension = (\n count: number,\n txt: readonly [one: string, two: string, five: string],\n cases = [2, 0, 1, 1, 1, 2],\n) =>\n txt[count % 100 > 4 && count % 100 < 20 ? 2 : cases[Math.min(count % 10, 5)]];\n\n/\n Splits text into lines with a maximum line length.\n */\nexport const splitTextByLines = (\n text: string,\n lineLingth: number = 60,\n): string[] => {\n const words = text.split(/\\s+/).filter((word) => word !== '');\n const lines = [];\n let currentLine = '';\n\n for (const word of words) {\n if (word.length > lineLingth) {\n if (currentLine !== '') {\n lines.push(currentLine);\n currentLine = '';\n }\n\n let start = 0;\n while (start < word.length) {\n const chunk = word.slice(start, start + lineLingth);\n lines.push(chunk);\n start += lineLingth;\n }\n continue;\n }\n\n // Проверка возможности добавления слова в текущую строку\n if (currentLine === '') {\n currentLine = word;\n } else if (currentLine.length + 1 + word.length <= lineLingth) {\n currentLine += ` ${word}`;\n } else {\n lines.push(currentLine);\n currentLine = word;\n }\n }\n\n if (currentLine !== '' \|\| lines.length === 0) {\n lines.push(currentLine);\n }\n\n return lines;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,IAAa,cACX,OACA,KACA,QAAQ;CAAC;CAAG;CAAG;CAAG;CAAG;CAAG;CAAE,KAE1B,IAAI,QAAQ,MAAM,KAAK,QAAQ,MAAM,KAAK,IAAI,MAAM,KAAK,IAAI,QAAQ,IAAI,EAAE;;;;AAK7E,IAAa,oBACX,MACA,aAAqB,OACR;CACb,MAAM,QAAQ,KAAK,MAAM,MAAM,CAAC,QAAQ,SAAS,SAAS,GAAG;CAC7D,MAAM,QAAQ,EAAE;CAChB,IAAI,cAAc;AAElB,MAAK,MAAM,QAAQ,OAAO;AACxB,MAAI,KAAK,SAAS,YAAY;AAC5B,OAAI,gBAAgB,IAAI;AACtB,UAAM,KAAK,YAAY;AACvB,kBAAc;;GAGhB,IAAI,QAAQ;AACZ,UAAO,QAAQ,KAAK,QAAQ;IAC1B,MAAM,QAAQ,KAAK,MAAM,OAAO,QAAQ,WAAW;AACnD,UAAM,KAAK,MAAM;AACjB,aAAS;;AAEX;;AAIF,MAAI,gBAAgB,GAClB,eAAc;WACL,YAAY,SAAS,IAAI,KAAK,UAAU,WACjD,gBAAe,IAAI;OACd;AACL,SAAM,KAAK,YAAY;AACvB,iBAAc;;;AAIlB,KAAI,gBAAgB,MAAM,MAAM,WAAW,EACzC,OAAM,KAAK,YAAY;AAGzB,QAAO"}

package/type-guard.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"type-guard.cjs","names":[],"sources":["../src/type-guard/_exports.ts"],"sourcesContent":["import type { AnyFunction, AnyObject, ValueOf } from 'yummies/types';\n\nconst TYPE = {\n Null: 'null',\n Undefined: 'undefined',\n NaN: 'nan',\n Object: '[object Object]',\n Array: '[object Array]',\n String: '[object String]',\n Number: '[object Number]',\n Boolean: '[object Boolean]',\n Function: '[object Function]',\n AsyncFunction: '[object AsyncFunction]',\n RegExp: '[object RegExp]',\n Symbol: '[object Symbol]',\n Infinite: 'infinite',\n Element: 'element',\n};\n\ntype Type = ValueOf<typeof TYPE>;\n\nfunction getType(value: unknown): Type {\n if (value === undefined) {\n return TYPE.Undefined;\n }\n if (value === null) {\n return TYPE.Null;\n }\n\n // handle DOM elements\n // @ts-expect-error\n if (value && (value.nodeType === 1 \|\| value.nodeType === 9)) {\n return TYPE.Element;\n }\n\n const stringifiedValue = Object.prototype.toString.call(value);\n\n // handle NaN and Infinity\n if (stringifiedValue === TYPE.Number) {\n if (Number.isNaN(value as number)) {\n return TYPE.NaN;\n }\n if (!Number.isFinite(value as number)) {\n return TYPE.Infinite;\n }\n }\n\n return stringifiedValue as Type;\n}\n\nconst createTypeGuard =\n <T>(...types: Type[]) =>\n (value: unknown): value is T =>\n types.includes(getType(value));\n\n/*\n Checks that a value is neither `null` nor `undefined`.\n \n @template T Value type without nullish branches.\n * @param value Value to test.\n * @returns `true` when the value is defined.\n \n @example\n * ```ts\n * isDefined(0); // true\n * ```\n \n @example\n * ```ts\n * isDefined(null); // false\n * ```\n /\nexport const isDefined = <T>(value: T \| undefined \| null): value is T =>\n value != null;\n\n/\n Checks whether a value is exactly `null`.\n \n @param value Value to test.\n * @returns `true` when the value is `null`.\n \n @example\n * ```ts\n * isNull(null); // true\n * ```\n \n @example\n * ```ts\n * isNull(undefined); // false\n * ```\n /\nexport const isNull = createTypeGuard<null>(TYPE.Null);\n\n/\n Checks whether a value is exactly `undefined`.\n \n @param value Value to test.\n * @returns `true` when the value is `undefined`.\n \n @example\n * ```ts\n * isUndefined(undefined); // true\n * ```\n \n @example\n * ```ts\n * isUndefined('value'); // false\n * ```\n /\nexport const isUndefined = createTypeGuard<undefined>(TYPE.Undefined);\n\n/\n Checks whether a value is a plain object.\n \n @param value Value to test.\n * @returns `true` when the value matches `[object Object]`.\n \n @example\n * ```ts\n * isObject({ id: 1 }); // true\n * ```\n \n @example\n * ```ts\n * isObject([]); // false\n * ```\n /\nexport const isObject = createTypeGuard<AnyObject>(TYPE.Object);\n\n/\n Checks whether a value is an array.\n \n @param value Value to test.\n * @returns `true` when the value is an array.\n \n @example\n * ```ts\n * isArray([1, 2, 3]); // true\n * ```\n \n @example\n * ```ts\n * isArray({ length: 1 }); // false\n * ```\n /\nexport const isArray = createTypeGuard<unknown[]>(TYPE.Array);\n\n/\n Checks whether a value is a string object or primitive string.\n \n @param value Value to test.\n * @returns `true` when the value is a string.\n \n @example\n * ```ts\n * isString('hello'); // true\n * ```\n \n @example\n * ```ts\n * isString(123); // false\n * ```\n /\nexport const isString = createTypeGuard<string>(TYPE.String);\n\n/\n Checks whether a value is a finite number.\n \n Unlike `isNaN` and `isInfinite`, this guard only matches regular numeric values.\n \n @param value Value to test.\n * @returns `true` when the value is a non-NaN finite number.\n \n @example\n * ```ts\n * isNumber(123); // true\n * ```\n \n @example\n * ```ts\n * isNumber(Number.NaN); // false\n * ```\n /\nexport const isNumber = createTypeGuard<number>(TYPE.Number);\n\n/\n Checks whether a value is a boolean.\n \n @param value Value to test.\n * @returns `true` when the value is a boolean.\n \n @example\n * ```ts\n * isBoolean(true); // true\n * ```\n \n @example\n * ```ts\n * isBoolean('true'); // false\n * ```\n /\nexport const isBoolean = createTypeGuard<boolean>(TYPE.Boolean);\n\n/\n Checks whether a value is a synchronous or asynchronous function.\n \n @param value Value to test.\n * @returns `true` when the value is a function.\n \n @example\n * ```ts\n * isFunction(() => {}); // true\n * ```\n \n @example\n * ```ts\n * isFunction(async () => {}); // true\n * ```\n /\nexport const isFunction = createTypeGuard<AnyFunction>(\n TYPE.Function,\n TYPE.AsyncFunction,\n);\n\n/\n Checks whether a value is a regular expression.\n \n @param value Value to test.\n * @returns `true` when the value is a `RegExp`.\n \n @example\n * ```ts\n * isRegExp(/foo/); // true\n * ```\n \n @example\n * ```ts\n * isRegExp('foo'); // false\n * ```\n /\nexport const isRegExp = createTypeGuard<RegExp>(TYPE.RegExp);\n\n/\n Checks whether a value looks like a DOM element or document node.\n \n @param value Value to test.\n * @returns `true` when the value has an element-like node type.\n \n @example\n * ```ts\n * isElement(document.body); // true\n * ```\n \n @example\n * ```ts\n * isElement({ nodeType: 3 }); // false\n * ```\n /\nexport const isElement = createTypeGuard<HTMLElement>(TYPE.Element);\n\n/\n Checks whether a value is `NaN`.\n \n @param value Value to test.\n * @returns `true` when the value is `NaN`.\n \n @example\n * ```ts\n * isNaN(Number.NaN); // true\n * ```\n \n @example\n * ```ts\n * isNaN(5); // false\n * ```\n /\nexport const isNaN = createTypeGuard<number>(TYPE.NaN) as (\n value: unknown,\n) => boolean;\n\n/\n Checks whether a value is positive or negative infinity.\n \n @param value Value to test.\n * @returns `true` when the value is not finite.\n \n @example\n * ```ts\n * isInfinite(Infinity); // true\n * ```\n \n @example\n * ```ts\n * isInfinite(10); // false\n * ```\n /\nexport const isInfinite = createTypeGuard<number>(TYPE.Infinite) as (\n value: unknown,\n) => boolean;\n\n/\n Checks whether a value is a symbol.\n \n @param value Value to test.\n * @returns `true` when the value is a symbol.\n \n @example\n * ```ts\n * isSymbol(Symbol('id')); // true\n * ```\n \n @example\n * ```ts\n * isSymbol('id'); // false\n * ```\n */\nexport const isSymbol = createTypeGuard<symbol>(TYPE.Symbol);\n"],"mappings":";;;;;;;;;;;;;;;;;;~~AAEA~~,IAAM,OAAO;CACX,MAAM;CACN,WAAW;CACX,KAAK;CACL,QAAQ;CACR,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,UAAU;CACV,eAAe;CACf,QAAQ;CACR,QAAQ;CACR,UAAU;CACV,SAAS;CACV;AAID,SAAS,QAAQ,OAAsB;AACrC,KAAI,UAAU,KAAA,EACZ,QAAO,KAAK;AAEd,KAAI,UAAU,KACZ,QAAO,KAAK;AAKd,KAAI,UAAU,MAAM,aAAa,KAAK,MAAM,aAAa,GACvD,QAAO,KAAK;CAGd,MAAM,mBAAmB,OAAO,UAAU,SAAS,KAAK,MAAM;AAG9D,KAAI,qBAAqB,KAAK,QAAQ;AACpC,MAAI,OAAO,MAAM,MAAgB,CAC/B,QAAO,KAAK;AAEd,MAAI,CAAC,OAAO,SAAS,MAAgB,CACnC,QAAO,KAAK;;AAIhB,QAAO;;AAGT,IAAM,mBACA,GAAG,WACN,UACC,MAAM,SAAS,QAAQ,MAAM,CAAC;;;;;;;;;;;;;;;;;;AAmBlC,IAAa,aAAgB,UAC3B,SAAS;;;;;;;;;;;;;;;;;AAkBX,IAAa,SAAS,gBAAsB,KAAK,KAAK;;;;;;;;;;;;;;;;;AAkBtD,IAAa,cAAc,gBAA2B,KAAK,UAAU;;;;;;;;;;;;;;;;;AAkBrE,IAAa,WAAW,gBAA2B,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB/D,IAAa,UAAU,gBAA2B,KAAK,MAAM;;;;;;;;;;;;;;;;;AAkB7D,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;;;AAoB5D,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB5D,IAAa,YAAY,gBAAyB,KAAK,QAAQ;;;;;;;;;;;;;;;;;AAkB/D,IAAa,aAAa,gBACxB,KAAK,UACL,KAAK,cACN;;;;;;;;;;;;;;;;;AAkBD,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB5D,IAAa,YAAY,gBAA6B,KAAK,QAAQ;;;;;;;;;;;;;;;;;AAkBnE,IAAa,QAAQ,gBAAwB,KAAK,IAAI;;;;;;;;;;;;;;;;;AAoBtD,IAAa,aAAa,gBAAwB,KAAK,SAAS;;;;;;;;;;;;;;;;;AAoBhE,IAAa,WAAW,gBAAwB,KAAK,OAAO"}
1	+ {"version":3,"file":"type-guard.cjs","names":[],"sources":["../src/type-guard/_exports.ts"],"sourcesContent":["/*\n ---header-docs-section---\n * # yummies/type-guard\n \n ## Description\n \n Runtime type guards and narrowers for primitives, DOM nodes, `NaN`, and common app values.\n * Each helper is implemented once with consistent `typeof` / `Object.prototype.toString` logic so\n * `unknown` from JSON, events, or third-party scripts becomes safe typed branches without ad-hoc\n * checks scattered through the codebase.\n \n ## Usage\n \n ```ts\n * import { typeGuard } from \"yummies/type-guard\";\n * ```\n /\n\nimport type { AnyFunction, AnyObject, ValueOf } from 'yummies/types';\n\nconst TYPE = {\n Null: 'null',\n Undefined: 'undefined',\n NaN: 'nan',\n Object: '[object Object]',\n Array: '[object Array]',\n String: '[object String]',\n Number: '[object Number]',\n Boolean: '[object Boolean]',\n Function: '[object Function]',\n AsyncFunction: '[object AsyncFunction]',\n RegExp: '[object RegExp]',\n Symbol: '[object Symbol]',\n Infinite: 'infinite',\n Element: 'element',\n};\n\ntype Type = ValueOf<typeof TYPE>;\n\nfunction getType(value: unknown): Type {\n if (value === undefined) {\n return TYPE.Undefined;\n }\n if (value === null) {\n return TYPE.Null;\n }\n\n // handle DOM elements\n // @ts-expect-error\n if (value && (value.nodeType === 1 \|\| value.nodeType === 9)) {\n return TYPE.Element;\n }\n\n const stringifiedValue = Object.prototype.toString.call(value);\n\n // handle NaN and Infinity\n if (stringifiedValue === TYPE.Number) {\n if (Number.isNaN(value as number)) {\n return TYPE.NaN;\n }\n if (!Number.isFinite(value as number)) {\n return TYPE.Infinite;\n }\n }\n\n return stringifiedValue as Type;\n}\n\nconst createTypeGuard =\n <T>(...types: Type[]) =>\n (value: unknown): value is T =>\n types.includes(getType(value));\n\n/\n Checks that a value is neither `null` nor `undefined`.\n \n @template T Value type without nullish branches.\n * @param value Value to test.\n * @returns `true` when the value is defined.\n \n @example\n * ```ts\n * isDefined(0); // true\n * ```\n \n @example\n * ```ts\n * isDefined(null); // false\n * ```\n /\nexport const isDefined = <T>(value: T \| undefined \| null): value is T =>\n value != null;\n\n/\n Checks whether a value is exactly `null`.\n \n @param value Value to test.\n * @returns `true` when the value is `null`.\n \n @example\n * ```ts\n * isNull(null); // true\n * ```\n \n @example\n * ```ts\n * isNull(undefined); // false\n * ```\n /\nexport const isNull = createTypeGuard<null>(TYPE.Null);\n\n/\n Checks whether a value is exactly `undefined`.\n \n @param value Value to test.\n * @returns `true` when the value is `undefined`.\n \n @example\n * ```ts\n * isUndefined(undefined); // true\n * ```\n \n @example\n * ```ts\n * isUndefined('value'); // false\n * ```\n /\nexport const isUndefined = createTypeGuard<undefined>(TYPE.Undefined);\n\n/\n Checks whether a value is a plain object.\n \n @param value Value to test.\n * @returns `true` when the value matches `[object Object]`.\n \n @example\n * ```ts\n * isObject({ id: 1 }); // true\n * ```\n \n @example\n * ```ts\n * isObject([]); // false\n * ```\n /\nexport const isObject = createTypeGuard<AnyObject>(TYPE.Object);\n\n/\n Checks whether a value is an array.\n \n @param value Value to test.\n * @returns `true` when the value is an array.\n \n @example\n * ```ts\n * isArray([1, 2, 3]); // true\n * ```\n \n @example\n * ```ts\n * isArray({ length: 1 }); // false\n * ```\n /\nexport const isArray = createTypeGuard<unknown[]>(TYPE.Array);\n\n/\n Checks whether a value is a string object or primitive string.\n \n @param value Value to test.\n * @returns `true` when the value is a string.\n \n @example\n * ```ts\n * isString('hello'); // true\n * ```\n \n @example\n * ```ts\n * isString(123); // false\n * ```\n /\nexport const isString = createTypeGuard<string>(TYPE.String);\n\n/\n Checks whether a value is a finite number.\n \n Unlike `isNaN` and `isInfinite`, this guard only matches regular numeric values.\n \n @param value Value to test.\n * @returns `true` when the value is a non-NaN finite number.\n \n @example\n * ```ts\n * isNumber(123); // true\n * ```\n \n @example\n * ```ts\n * isNumber(Number.NaN); // false\n * ```\n /\nexport const isNumber = createTypeGuard<number>(TYPE.Number);\n\n/\n Checks whether a value is a boolean.\n \n @param value Value to test.\n * @returns `true` when the value is a boolean.\n \n @example\n * ```ts\n * isBoolean(true); // true\n * ```\n \n @example\n * ```ts\n * isBoolean('true'); // false\n * ```\n /\nexport const isBoolean = createTypeGuard<boolean>(TYPE.Boolean);\n\n/\n Checks whether a value is a synchronous or asynchronous function.\n \n @param value Value to test.\n * @returns `true` when the value is a function.\n \n @example\n * ```ts\n * isFunction(() => {}); // true\n * ```\n \n @example\n * ```ts\n * isFunction(async () => {}); // true\n * ```\n /\nexport const isFunction = createTypeGuard<AnyFunction>(\n TYPE.Function,\n TYPE.AsyncFunction,\n);\n\n/\n Checks whether a value is a regular expression.\n \n @param value Value to test.\n * @returns `true` when the value is a `RegExp`.\n \n @example\n * ```ts\n * isRegExp(/foo/); // true\n * ```\n \n @example\n * ```ts\n * isRegExp('foo'); // false\n * ```\n /\nexport const isRegExp = createTypeGuard<RegExp>(TYPE.RegExp);\n\n/\n Checks whether a value looks like a DOM element or document node.\n \n @param value Value to test.\n * @returns `true` when the value has an element-like node type.\n \n @example\n * ```ts\n * isElement(document.body); // true\n * ```\n \n @example\n * ```ts\n * isElement({ nodeType: 3 }); // false\n * ```\n /\nexport const isElement = createTypeGuard<HTMLElement>(TYPE.Element);\n\n/\n Checks whether a value is `NaN`.\n \n @param value Value to test.\n * @returns `true` when the value is `NaN`.\n \n @example\n * ```ts\n * isNaN(Number.NaN); // true\n * ```\n \n @example\n * ```ts\n * isNaN(5); // false\n * ```\n /\nexport const isNaN = createTypeGuard<number>(TYPE.NaN) as (\n value: unknown,\n) => boolean;\n\n/\n Checks whether a value is positive or negative infinity.\n \n @param value Value to test.\n * @returns `true` when the value is not finite.\n \n @example\n * ```ts\n * isInfinite(Infinity); // true\n * ```\n \n @example\n * ```ts\n * isInfinite(10); // false\n * ```\n /\nexport const isInfinite = createTypeGuard<number>(TYPE.Infinite) as (\n value: unknown,\n) => boolean;\n\n/\n Checks whether a value is a symbol.\n \n @param value Value to test.\n * @returns `true` when the value is a symbol.\n \n @example\n * ```ts\n * isSymbol(Symbol('id')); // true\n * ```\n \n @example\n * ```ts\n * isSymbol('id'); // false\n * ```\n */\nexport const isSymbol = createTypeGuard<symbol>(TYPE.Symbol);\n"],"mappings":";;;;;;;;;;;;;;;;;;AAoBA,IAAM,OAAO;CACX,MAAM;CACN,WAAW;CACX,KAAK;CACL,QAAQ;CACR,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,UAAU;CACV,eAAe;CACf,QAAQ;CACR,QAAQ;CACR,UAAU;CACV,SAAS;CACV;AAID,SAAS,QAAQ,OAAsB;AACrC,KAAI,UAAU,KAAA,EACZ,QAAO,KAAK;AAEd,KAAI,UAAU,KACZ,QAAO,KAAK;AAKd,KAAI,UAAU,MAAM,aAAa,KAAK,MAAM,aAAa,GACvD,QAAO,KAAK;CAGd,MAAM,mBAAmB,OAAO,UAAU,SAAS,KAAK,MAAM;AAG9D,KAAI,qBAAqB,KAAK,QAAQ;AACpC,MAAI,OAAO,MAAM,MAAgB,CAC/B,QAAO,KAAK;AAEd,MAAI,CAAC,OAAO,SAAS,MAAgB,CACnC,QAAO,KAAK;;AAIhB,QAAO;;AAGT,IAAM,mBACA,GAAG,WACN,UACC,MAAM,SAAS,QAAQ,MAAM,CAAC;;;;;;;;;;;;;;;;;;AAmBlC,IAAa,aAAgB,UAC3B,SAAS;;;;;;;;;;;;;;;;;AAkBX,IAAa,SAAS,gBAAsB,KAAK,KAAK;;;;;;;;;;;;;;;;;AAkBtD,IAAa,cAAc,gBAA2B,KAAK,UAAU;;;;;;;;;;;;;;;;;AAkBrE,IAAa,WAAW,gBAA2B,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB/D,IAAa,UAAU,gBAA2B,KAAK,MAAM;;;;;;;;;;;;;;;;;AAkB7D,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;;;AAoB5D,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB5D,IAAa,YAAY,gBAAyB,KAAK,QAAQ;;;;;;;;;;;;;;;;;AAkB/D,IAAa,aAAa,gBACxB,KAAK,UACL,KAAK,cACN;;;;;;;;;;;;;;;;;AAkBD,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB5D,IAAa,YAAY,gBAA6B,KAAK,QAAQ;;;;;;;;;;;;;;;;;AAkBnE,IAAa,QAAQ,gBAAwB,KAAK,IAAI;;;;;;;;;;;;;;;;;AAoBtD,IAAa,aAAa,gBAAwB,KAAK,SAAS;;;;;;;;;;;;;;;;;AAoBhE,IAAa,WAAW,gBAAwB,KAAK,OAAO"}

package/type-guard.d.ts CHANGED Viewed

@@ -1,5 +1,23 @@
 import { AnyFunction, AnyObject } from 'yummies/types';
+/**
+ * ---header-docs-section---
+ * # yummies/type-guard
+ *
+ * ## Description
+ *
+ * Runtime **type guards** and narrowers for primitives, DOM nodes, `NaN`, and common app values.
+ * Each helper is implemented once with consistent `typeof` / `Object.prototype.toString` logic so
+ * `unknown` from JSON, events, or third-party scripts becomes safe typed branches without ad-hoc
+ * checks scattered through the codebase.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { typeGuard } from "yummies/type-guard";
+ * ```
+ */
 /**
  * Checks that a value is neither `null` nor `undefined`.
  *

package/type-guard.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"type-guard.js","names":[],"sources":["../src/type-guard/_exports.ts"],"sourcesContent":["import type { AnyFunction, AnyObject, ValueOf } from 'yummies/types';\n\nconst TYPE = {\n Null: 'null',\n Undefined: 'undefined',\n NaN: 'nan',\n Object: '[object Object]',\n Array: '[object Array]',\n String: '[object String]',\n Number: '[object Number]',\n Boolean: '[object Boolean]',\n Function: '[object Function]',\n AsyncFunction: '[object AsyncFunction]',\n RegExp: '[object RegExp]',\n Symbol: '[object Symbol]',\n Infinite: 'infinite',\n Element: 'element',\n};\n\ntype Type = ValueOf<typeof TYPE>;\n\nfunction getType(value: unknown): Type {\n if (value === undefined) {\n return TYPE.Undefined;\n }\n if (value === null) {\n return TYPE.Null;\n }\n\n // handle DOM elements\n // @ts-expect-error\n if (value && (value.nodeType === 1 \|\| value.nodeType === 9)) {\n return TYPE.Element;\n }\n\n const stringifiedValue = Object.prototype.toString.call(value);\n\n // handle NaN and Infinity\n if (stringifiedValue === TYPE.Number) {\n if (Number.isNaN(value as number)) {\n return TYPE.NaN;\n }\n if (!Number.isFinite(value as number)) {\n return TYPE.Infinite;\n }\n }\n\n return stringifiedValue as Type;\n}\n\nconst createTypeGuard =\n <T>(...types: Type[]) =>\n (value: unknown): value is T =>\n types.includes(getType(value));\n\n/*\n Checks that a value is neither `null` nor `undefined`.\n \n @template T Value type without nullish branches.\n * @param value Value to test.\n * @returns `true` when the value is defined.\n \n @example\n * ```ts\n * isDefined(0); // true\n * ```\n \n @example\n * ```ts\n * isDefined(null); // false\n * ```\n /\nexport const isDefined = <T>(value: T \| undefined \| null): value is T =>\n value != null;\n\n/\n Checks whether a value is exactly `null`.\n \n @param value Value to test.\n * @returns `true` when the value is `null`.\n \n @example\n * ```ts\n * isNull(null); // true\n * ```\n \n @example\n * ```ts\n * isNull(undefined); // false\n * ```\n /\nexport const isNull = createTypeGuard<null>(TYPE.Null);\n\n/\n Checks whether a value is exactly `undefined`.\n \n @param value Value to test.\n * @returns `true` when the value is `undefined`.\n \n @example\n * ```ts\n * isUndefined(undefined); // true\n * ```\n \n @example\n * ```ts\n * isUndefined('value'); // false\n * ```\n /\nexport const isUndefined = createTypeGuard<undefined>(TYPE.Undefined);\n\n/\n Checks whether a value is a plain object.\n \n @param value Value to test.\n * @returns `true` when the value matches `[object Object]`.\n \n @example\n * ```ts\n * isObject({ id: 1 }); // true\n * ```\n \n @example\n * ```ts\n * isObject([]); // false\n * ```\n /\nexport const isObject = createTypeGuard<AnyObject>(TYPE.Object);\n\n/\n Checks whether a value is an array.\n \n @param value Value to test.\n * @returns `true` when the value is an array.\n \n @example\n * ```ts\n * isArray([1, 2, 3]); // true\n * ```\n \n @example\n * ```ts\n * isArray({ length: 1 }); // false\n * ```\n /\nexport const isArray = createTypeGuard<unknown[]>(TYPE.Array);\n\n/\n Checks whether a value is a string object or primitive string.\n \n @param value Value to test.\n * @returns `true` when the value is a string.\n \n @example\n * ```ts\n * isString('hello'); // true\n * ```\n \n @example\n * ```ts\n * isString(123); // false\n * ```\n /\nexport const isString = createTypeGuard<string>(TYPE.String);\n\n/\n Checks whether a value is a finite number.\n \n Unlike `isNaN` and `isInfinite`, this guard only matches regular numeric values.\n \n @param value Value to test.\n * @returns `true` when the value is a non-NaN finite number.\n \n @example\n * ```ts\n * isNumber(123); // true\n * ```\n \n @example\n * ```ts\n * isNumber(Number.NaN); // false\n * ```\n /\nexport const isNumber = createTypeGuard<number>(TYPE.Number);\n\n/\n Checks whether a value is a boolean.\n \n @param value Value to test.\n * @returns `true` when the value is a boolean.\n \n @example\n * ```ts\n * isBoolean(true); // true\n * ```\n \n @example\n * ```ts\n * isBoolean('true'); // false\n * ```\n /\nexport const isBoolean = createTypeGuard<boolean>(TYPE.Boolean);\n\n/\n Checks whether a value is a synchronous or asynchronous function.\n \n @param value Value to test.\n * @returns `true` when the value is a function.\n \n @example\n * ```ts\n * isFunction(() => {}); // true\n * ```\n \n @example\n * ```ts\n * isFunction(async () => {}); // true\n * ```\n /\nexport const isFunction = createTypeGuard<AnyFunction>(\n TYPE.Function,\n TYPE.AsyncFunction,\n);\n\n/\n Checks whether a value is a regular expression.\n \n @param value Value to test.\n * @returns `true` when the value is a `RegExp`.\n \n @example\n * ```ts\n * isRegExp(/foo/); // true\n * ```\n \n @example\n * ```ts\n * isRegExp('foo'); // false\n * ```\n /\nexport const isRegExp = createTypeGuard<RegExp>(TYPE.RegExp);\n\n/\n Checks whether a value looks like a DOM element or document node.\n \n @param value Value to test.\n * @returns `true` when the value has an element-like node type.\n \n @example\n * ```ts\n * isElement(document.body); // true\n * ```\n \n @example\n * ```ts\n * isElement({ nodeType: 3 }); // false\n * ```\n /\nexport const isElement = createTypeGuard<HTMLElement>(TYPE.Element);\n\n/\n Checks whether a value is `NaN`.\n \n @param value Value to test.\n * @returns `true` when the value is `NaN`.\n \n @example\n * ```ts\n * isNaN(Number.NaN); // true\n * ```\n \n @example\n * ```ts\n * isNaN(5); // false\n * ```\n /\nexport const isNaN = createTypeGuard<number>(TYPE.NaN) as (\n value: unknown,\n) => boolean;\n\n/\n Checks whether a value is positive or negative infinity.\n \n @param value Value to test.\n * @returns `true` when the value is not finite.\n \n @example\n * ```ts\n * isInfinite(Infinity); // true\n * ```\n \n @example\n * ```ts\n * isInfinite(10); // false\n * ```\n /\nexport const isInfinite = createTypeGuard<number>(TYPE.Infinite) as (\n value: unknown,\n) => boolean;\n\n/\n Checks whether a value is a symbol.\n \n @param value Value to test.\n * @returns `true` when the value is a symbol.\n \n @example\n * ```ts\n * isSymbol(Symbol('id')); // true\n * ```\n \n @example\n * ```ts\n * isSymbol('id'); // false\n * ```\n */\nexport const isSymbol = createTypeGuard<symbol>(TYPE.Symbol);\n"],"mappings":";;;;;;;;;;;;;;;;;;~~AAEA~~,IAAM,OAAO;CACX,MAAM;CACN,WAAW;CACX,KAAK;CACL,QAAQ;CACR,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,UAAU;CACV,eAAe;CACf,QAAQ;CACR,QAAQ;CACR,UAAU;CACV,SAAS;CACV;AAID,SAAS,QAAQ,OAAsB;AACrC,KAAI,UAAU,KAAA,EACZ,QAAO,KAAK;AAEd,KAAI,UAAU,KACZ,QAAO,KAAK;AAKd,KAAI,UAAU,MAAM,aAAa,KAAK,MAAM,aAAa,GACvD,QAAO,KAAK;CAGd,MAAM,mBAAmB,OAAO,UAAU,SAAS,KAAK,MAAM;AAG9D,KAAI,qBAAqB,KAAK,QAAQ;AACpC,MAAI,OAAO,MAAM,MAAgB,CAC/B,QAAO,KAAK;AAEd,MAAI,CAAC,OAAO,SAAS,MAAgB,CACnC,QAAO,KAAK;;AAIhB,QAAO;;AAGT,IAAM,mBACA,GAAG,WACN,UACC,MAAM,SAAS,QAAQ,MAAM,CAAC;;;;;;;;;;;;;;;;;;AAmBlC,IAAa,aAAgB,UAC3B,SAAS;;;;;;;;;;;;;;;;;AAkBX,IAAa,SAAS,gBAAsB,KAAK,KAAK;;;;;;;;;;;;;;;;;AAkBtD,IAAa,cAAc,gBAA2B,KAAK,UAAU;;;;;;;;;;;;;;;;;AAkBrE,IAAa,WAAW,gBAA2B,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB/D,IAAa,UAAU,gBAA2B,KAAK,MAAM;;;;;;;;;;;;;;;;;AAkB7D,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;;;AAoB5D,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB5D,IAAa,YAAY,gBAAyB,KAAK,QAAQ;;;;;;;;;;;;;;;;;AAkB/D,IAAa,aAAa,gBACxB,KAAK,UACL,KAAK,cACN;;;;;;;;;;;;;;;;;AAkBD,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB5D,IAAa,YAAY,gBAA6B,KAAK,QAAQ;;;;;;;;;;;;;;;;;AAkBnE,IAAa,QAAQ,gBAAwB,KAAK,IAAI;;;;;;;;;;;;;;;;;AAoBtD,IAAa,aAAa,gBAAwB,KAAK,SAAS;;;;;;;;;;;;;;;;;AAoBhE,IAAa,WAAW,gBAAwB,KAAK,OAAO"}
1	+ {"version":3,"file":"type-guard.js","names":[],"sources":["../src/type-guard/_exports.ts"],"sourcesContent":["/*\n ---header-docs-section---\n * # yummies/type-guard\n \n ## Description\n \n Runtime type guards and narrowers for primitives, DOM nodes, `NaN`, and common app values.\n * Each helper is implemented once with consistent `typeof` / `Object.prototype.toString` logic so\n * `unknown` from JSON, events, or third-party scripts becomes safe typed branches without ad-hoc\n * checks scattered through the codebase.\n \n ## Usage\n \n ```ts\n * import { typeGuard } from \"yummies/type-guard\";\n * ```\n /\n\nimport type { AnyFunction, AnyObject, ValueOf } from 'yummies/types';\n\nconst TYPE = {\n Null: 'null',\n Undefined: 'undefined',\n NaN: 'nan',\n Object: '[object Object]',\n Array: '[object Array]',\n String: '[object String]',\n Number: '[object Number]',\n Boolean: '[object Boolean]',\n Function: '[object Function]',\n AsyncFunction: '[object AsyncFunction]',\n RegExp: '[object RegExp]',\n Symbol: '[object Symbol]',\n Infinite: 'infinite',\n Element: 'element',\n};\n\ntype Type = ValueOf<typeof TYPE>;\n\nfunction getType(value: unknown): Type {\n if (value === undefined) {\n return TYPE.Undefined;\n }\n if (value === null) {\n return TYPE.Null;\n }\n\n // handle DOM elements\n // @ts-expect-error\n if (value && (value.nodeType === 1 \|\| value.nodeType === 9)) {\n return TYPE.Element;\n }\n\n const stringifiedValue = Object.prototype.toString.call(value);\n\n // handle NaN and Infinity\n if (stringifiedValue === TYPE.Number) {\n if (Number.isNaN(value as number)) {\n return TYPE.NaN;\n }\n if (!Number.isFinite(value as number)) {\n return TYPE.Infinite;\n }\n }\n\n return stringifiedValue as Type;\n}\n\nconst createTypeGuard =\n <T>(...types: Type[]) =>\n (value: unknown): value is T =>\n types.includes(getType(value));\n\n/\n Checks that a value is neither `null` nor `undefined`.\n \n @template T Value type without nullish branches.\n * @param value Value to test.\n * @returns `true` when the value is defined.\n \n @example\n * ```ts\n * isDefined(0); // true\n * ```\n \n @example\n * ```ts\n * isDefined(null); // false\n * ```\n /\nexport const isDefined = <T>(value: T \| undefined \| null): value is T =>\n value != null;\n\n/\n Checks whether a value is exactly `null`.\n \n @param value Value to test.\n * @returns `true` when the value is `null`.\n \n @example\n * ```ts\n * isNull(null); // true\n * ```\n \n @example\n * ```ts\n * isNull(undefined); // false\n * ```\n /\nexport const isNull = createTypeGuard<null>(TYPE.Null);\n\n/\n Checks whether a value is exactly `undefined`.\n \n @param value Value to test.\n * @returns `true` when the value is `undefined`.\n \n @example\n * ```ts\n * isUndefined(undefined); // true\n * ```\n \n @example\n * ```ts\n * isUndefined('value'); // false\n * ```\n /\nexport const isUndefined = createTypeGuard<undefined>(TYPE.Undefined);\n\n/\n Checks whether a value is a plain object.\n \n @param value Value to test.\n * @returns `true` when the value matches `[object Object]`.\n \n @example\n * ```ts\n * isObject({ id: 1 }); // true\n * ```\n \n @example\n * ```ts\n * isObject([]); // false\n * ```\n /\nexport const isObject = createTypeGuard<AnyObject>(TYPE.Object);\n\n/\n Checks whether a value is an array.\n \n @param value Value to test.\n * @returns `true` when the value is an array.\n \n @example\n * ```ts\n * isArray([1, 2, 3]); // true\n * ```\n \n @example\n * ```ts\n * isArray({ length: 1 }); // false\n * ```\n /\nexport const isArray = createTypeGuard<unknown[]>(TYPE.Array);\n\n/\n Checks whether a value is a string object or primitive string.\n \n @param value Value to test.\n * @returns `true` when the value is a string.\n \n @example\n * ```ts\n * isString('hello'); // true\n * ```\n \n @example\n * ```ts\n * isString(123); // false\n * ```\n /\nexport const isString = createTypeGuard<string>(TYPE.String);\n\n/\n Checks whether a value is a finite number.\n \n Unlike `isNaN` and `isInfinite`, this guard only matches regular numeric values.\n \n @param value Value to test.\n * @returns `true` when the value is a non-NaN finite number.\n \n @example\n * ```ts\n * isNumber(123); // true\n * ```\n \n @example\n * ```ts\n * isNumber(Number.NaN); // false\n * ```\n /\nexport const isNumber = createTypeGuard<number>(TYPE.Number);\n\n/\n Checks whether a value is a boolean.\n \n @param value Value to test.\n * @returns `true` when the value is a boolean.\n \n @example\n * ```ts\n * isBoolean(true); // true\n * ```\n \n @example\n * ```ts\n * isBoolean('true'); // false\n * ```\n /\nexport const isBoolean = createTypeGuard<boolean>(TYPE.Boolean);\n\n/\n Checks whether a value is a synchronous or asynchronous function.\n \n @param value Value to test.\n * @returns `true` when the value is a function.\n \n @example\n * ```ts\n * isFunction(() => {}); // true\n * ```\n \n @example\n * ```ts\n * isFunction(async () => {}); // true\n * ```\n /\nexport const isFunction = createTypeGuard<AnyFunction>(\n TYPE.Function,\n TYPE.AsyncFunction,\n);\n\n/\n Checks whether a value is a regular expression.\n \n @param value Value to test.\n * @returns `true` when the value is a `RegExp`.\n \n @example\n * ```ts\n * isRegExp(/foo/); // true\n * ```\n \n @example\n * ```ts\n * isRegExp('foo'); // false\n * ```\n /\nexport const isRegExp = createTypeGuard<RegExp>(TYPE.RegExp);\n\n/\n Checks whether a value looks like a DOM element or document node.\n \n @param value Value to test.\n * @returns `true` when the value has an element-like node type.\n \n @example\n * ```ts\n * isElement(document.body); // true\n * ```\n \n @example\n * ```ts\n * isElement({ nodeType: 3 }); // false\n * ```\n /\nexport const isElement = createTypeGuard<HTMLElement>(TYPE.Element);\n\n/\n Checks whether a value is `NaN`.\n \n @param value Value to test.\n * @returns `true` when the value is `NaN`.\n \n @example\n * ```ts\n * isNaN(Number.NaN); // true\n * ```\n \n @example\n * ```ts\n * isNaN(5); // false\n * ```\n /\nexport const isNaN = createTypeGuard<number>(TYPE.NaN) as (\n value: unknown,\n) => boolean;\n\n/\n Checks whether a value is positive or negative infinity.\n \n @param value Value to test.\n * @returns `true` when the value is not finite.\n \n @example\n * ```ts\n * isInfinite(Infinity); // true\n * ```\n \n @example\n * ```ts\n * isInfinite(10); // false\n * ```\n /\nexport const isInfinite = createTypeGuard<number>(TYPE.Infinite) as (\n value: unknown,\n) => boolean;\n\n/\n Checks whether a value is a symbol.\n \n @param value Value to test.\n * @returns `true` when the value is a symbol.\n \n @example\n * ```ts\n * isSymbol(Symbol('id')); // true\n * ```\n \n @example\n * ```ts\n * isSymbol('id'); // false\n * ```\n */\nexport const isSymbol = createTypeGuard<symbol>(TYPE.Symbol);\n"],"mappings":";;;;;;;;;;;;;;;;;;AAoBA,IAAM,OAAO;CACX,MAAM;CACN,WAAW;CACX,KAAK;CACL,QAAQ;CACR,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,UAAU;CACV,eAAe;CACf,QAAQ;CACR,QAAQ;CACR,UAAU;CACV,SAAS;CACV;AAID,SAAS,QAAQ,OAAsB;AACrC,KAAI,UAAU,KAAA,EACZ,QAAO,KAAK;AAEd,KAAI,UAAU,KACZ,QAAO,KAAK;AAKd,KAAI,UAAU,MAAM,aAAa,KAAK,MAAM,aAAa,GACvD,QAAO,KAAK;CAGd,MAAM,mBAAmB,OAAO,UAAU,SAAS,KAAK,MAAM;AAG9D,KAAI,qBAAqB,KAAK,QAAQ;AACpC,MAAI,OAAO,MAAM,MAAgB,CAC/B,QAAO,KAAK;AAEd,MAAI,CAAC,OAAO,SAAS,MAAgB,CACnC,QAAO,KAAK;;AAIhB,QAAO;;AAGT,IAAM,mBACA,GAAG,WACN,UACC,MAAM,SAAS,QAAQ,MAAM,CAAC;;;;;;;;;;;;;;;;;;AAmBlC,IAAa,aAAgB,UAC3B,SAAS;;;;;;;;;;;;;;;;;AAkBX,IAAa,SAAS,gBAAsB,KAAK,KAAK;;;;;;;;;;;;;;;;;AAkBtD,IAAa,cAAc,gBAA2B,KAAK,UAAU;;;;;;;;;;;;;;;;;AAkBrE,IAAa,WAAW,gBAA2B,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB/D,IAAa,UAAU,gBAA2B,KAAK,MAAM;;;;;;;;;;;;;;;;;AAkB7D,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;;;AAoB5D,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB5D,IAAa,YAAY,gBAAyB,KAAK,QAAQ;;;;;;;;;;;;;;;;;AAkB/D,IAAa,aAAa,gBACxB,KAAK,UACL,KAAK,cACN;;;;;;;;;;;;;;;;;AAkBD,IAAa,WAAW,gBAAwB,KAAK,OAAO;;;;;;;;;;;;;;;;;AAkB5D,IAAa,YAAY,gBAA6B,KAAK,QAAQ;;;;;;;;;;;;;;;;;AAkBnE,IAAa,QAAQ,gBAAwB,KAAK,IAAI;;;;;;;;;;;;;;;;;AAoBtD,IAAa,aAAa,gBAAwB,KAAK,SAAS;;;;;;;;;;;;;;;;;AAoBhE,IAAa,WAAW,gBAAwB,KAAK,OAAO"}

package/types.d.ts CHANGED Viewed

@@ -1,3 +1,44 @@
+/**
+ * ---header-docs-section---
+ * # yummies/types
+ *
+ * ## Description
+ *
+ * This module collects **TypeScript-only** helpers: `ValueOf`, nullable aliases, branded types, and
+ * patterns for props and generics. Nothing here exists at runtime — use `import type` so bundlers
+ * drop the imports entirely. The same ideas are also published as **ambient** globals under a
+ * separate entry (see below) when you want types in scope without repeating imports in every file.
+ *
+ * ## `yummies/types.global`
+ *
+ * Use this subpath when you prefer **global** declarations (no per-file imports). After installing
+ * the package, reference the built `.d.ts` bundle — typically via a side-effect import that pulls
+ * ambient types into the compilation unit:
+ *
+ * ```ts
+ * import "yummies/types.global";
+ * ```
+ *
+ * Or list it under `compilerOptions.types` in **`tsconfig.json`** so `tsc` loads it for the project:
+ *
+ * ```json
+ * {
+ *   "compilerOptions": {
+ *     "types": ["yummies/types.global"]
+ *   }
+ * }
+ * ```
+ *
+ * ## `yummies/types` (library)
+ *
+ * Prefer this entry when you want **explicit**, traceable imports at each call site (tree-shaking
+ * friendly and clearer in reviews). The root package may re-export some symbols, but
+ * **`yummies/types`** is the dedicated surface for type-only utilities.
+ *
+ * ```ts
+ * import type { AnyObject, Maybe } from "yummies/types";
+ * ```
+ */
 /**
  * Extracts all values from an object or array type.
  *

package/types.global.d.ts CHANGED Viewed

@@ -1,4 +1,45 @@
 /** THIS IS AUTOGENERATED FILE FROM "utils/types.ts" */
+/**
+ * ---header-docs-section---
+ * # yummies/types
+ *
+ * ## Description
+ *
+ * This module collects **TypeScript-only** helpers: `ValueOf`, nullable aliases, branded types, and
+ * patterns for props and generics. Nothing here exists at runtime — use `import type` so bundlers
+ * drop the imports entirely. The same ideas are also published as **ambient** globals under a
+ * separate entry (see below) when you want types in scope without repeating imports in every file.
+ *
+ * ## `yummies/types.global`
+ *
+ * Use this subpath when you prefer **global** declarations (no per-file imports). After installing
+ * the package, reference the built `.d.ts` bundle — typically via a side-effect import that pulls
+ * ambient types into the compilation unit:
+ *
+ * ```ts
+ * import "yummies/types.global";
+ * ```
+ *
+ * Or list it under `compilerOptions.types` in **`tsconfig.json`** so `tsc` loads it for the project:
+ *
+ * ```json
+ * {
+ *   "compilerOptions": {
+ *     "types": ["yummies/types.global"]
+ *   }
+ * }
+ * ```
+ *
+ * ## `yummies/types` (library)
+ *
+ * Prefer this entry when you want **explicit**, traceable imports at each call site (tree-shaking
+ * friendly and clearer in reviews). The root package may re-export some symbols, but
+ * **`yummies/types`** is the dedicated surface for type-only utilities.
+ *
+ * ```ts
+ * import type { AnyObject, Maybe } from "yummies/types";
+ * ```
+ */
 /**
  * Extracts all values from an object or array type.
  *

package/vibrate.cjs CHANGED Viewed

@@ -1,6 +1,22 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/vibrate.ts
 /**
+* ---header-docs-section---
+* # yummies/vibrate
+*
+* ## Description
+*
+* Thin wrapper around **`navigator.vibrate`** for mobile-style haptics: single pulses or patterned
+* on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not
+* rely on vibration for critical feedback because iOS and many desktops omit the API entirely.
+*
+* ## Usage
+*
+* ```ts
+* import { vibrate } from "yummies/vibrate";
+* ```
+*/
+/**
 * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}
 * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).
 *

package/vibrate.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"vibrate.cjs","names":[],"sources":["../src/vibrate.ts"],"sourcesContent":["/*\n Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API \| Vibration API}\n * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).\n \n - Single number — vibrate for that many milliseconds, then stop.\n * - Array of numbers — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.\n * Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.\n \n If the API is unavailable or the user has disabled vibration, this function does nothing\n * (no throw). Call sites should not rely on vibration for critical UX.\n \n @param pattern - Duration in ms, or a pattern array as described above.\n \n @example\n * Short confirmation buzz (200 ms):\n * ```ts\n * vibrate(200);\n * ```\n \n @example\n * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:\n * ```ts\n * vibrate([100, 50, 100]);\n * ```\n */\nexport const vibrate = (pattern: number \| number[]) => {\n if ('vibrate' in navigator) {\n navigator.vibrate(pattern);\n }\n};\n"],"mappings":"~~;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA~~,IAAa,WAAW,YAA+B;AACrD,KAAI,aAAa,UACf,WAAU,QAAQ,QAAQ"}
1	+ {"version":3,"file":"vibrate.cjs","names":[],"sources":["../src/vibrate.ts"],"sourcesContent":["/*\n ---header-docs-section---\n * # yummies/vibrate\n \n ## Description\n \n Thin wrapper around `navigator.vibrate` for mobile-style haptics: single pulses or patterned\n * on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not\n * rely on vibration for critical feedback because iOS and many desktops omit the API entirely.\n \n ## Usage\n \n ```ts\n * import { vibrate } from \"yummies/vibrate\";\n * ```\n /\n\n/\n Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API \| Vibration API}\n * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).\n \n - Single number — vibrate for that many milliseconds, then stop.\n * - Array of numbers — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.\n * Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.\n \n If the API is unavailable or the user has disabled vibration, this function does nothing\n * (no throw). Call sites should not rely on vibration for critical UX.\n \n @param pattern - Duration in ms, or a pattern array as described above.\n \n @example\n * Short confirmation buzz (200 ms):\n * ```ts\n * vibrate(200);\n * ```\n \n @example\n * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:\n * ```ts\n * vibrate([100, 50, 100]);\n * ```\n */\nexport const vibrate = (pattern: number \| number[]) => {\n if ('vibrate' in navigator) {\n navigator.vibrate(pattern);\n }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,IAAa,WAAW,YAA+B;AACrD,KAAI,aAAa,UACf,WAAU,QAAQ,QAAQ"}

package/vibrate.d.ts CHANGED Viewed

@@ -1,3 +1,19 @@
+/**
+ * ---header-docs-section---
+ * # yummies/vibrate
+ *
+ * ## Description
+ *
+ * Thin wrapper around **`navigator.vibrate`** for mobile-style haptics: single pulses or patterned
+ * on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not
+ * rely on vibration for critical feedback because iOS and many desktops omit the API entirely.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { vibrate } from "yummies/vibrate";
+ * ```
+ */
 /**
  * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}
  * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).

package/vibrate.js CHANGED Viewed

@@ -1,5 +1,21 @@
 //#region src/vibrate.ts
 /**
+* ---header-docs-section---
+* # yummies/vibrate
+*
+* ## Description
+*
+* Thin wrapper around **`navigator.vibrate`** for mobile-style haptics: single pulses or patterned
+* on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not
+* rely on vibration for critical feedback because iOS and many desktops omit the API entirely.
+*
+* ## Usage
+*
+* ```ts
+* import { vibrate } from "yummies/vibrate";
+* ```
+*/
+/**
 * Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API | Vibration API}
 * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).
 *

package/vibrate.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"vibrate.js","names":[],"sources":["../src/vibrate.ts"],"sourcesContent":["/*\n Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API \| Vibration API}\n * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).\n \n - Single number — vibrate for that many milliseconds, then stop.\n * - Array of numbers — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.\n * Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.\n \n If the API is unavailable or the user has disabled vibration, this function does nothing\n * (no throw). Call sites should not rely on vibration for critical UX.\n \n @param pattern - Duration in ms, or a pattern array as described above.\n \n @example\n * Short confirmation buzz (200 ms):\n * ```ts\n * vibrate(200);\n * ```\n \n @example\n * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:\n * ```ts\n * vibrate([100, 50, 100]);\n * ```\n */\nexport const vibrate = (pattern: number \| number[]) => {\n if ('vibrate' in navigator) {\n navigator.vibrate(pattern);\n }\n};\n"],"mappings":"~~;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA~~,IAAa,WAAW,YAA+B;AACrD,KAAI,aAAa,UACf,WAAU,QAAQ,QAAQ"}
1	+ {"version":3,"file":"vibrate.js","names":[],"sources":["../src/vibrate.ts"],"sourcesContent":["/*\n ---header-docs-section---\n * # yummies/vibrate\n \n ## Description\n \n Thin wrapper around `navigator.vibrate` for mobile-style haptics: single pulses or patterned\n * on/off sequences. It no-ops when the API is missing or disabled, so UI code stays simple. Do not\n * rely on vibration for critical feedback because iOS and many desktops omit the API entirely.\n \n ## Usage\n \n ```ts\n * import { vibrate } from \"yummies/vibrate\";\n * ```\n /\n\n/\n Triggers haptic feedback via the {@link https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API \| Vibration API}\n * when `navigator.vibrate` exists (common on Android Chrome; often missing on iOS Safari / desktop).\n \n - Single number — vibrate for that many milliseconds, then stop.\n * - Array of numbers — alternating vibration and pause lengths in ms: `[vibrate, pause, vibrate, ...]`.\n * Per the spec, values are clamped; odd-length arrays imply a trailing vibrate segment.\n \n If the API is unavailable or the user has disabled vibration, this function does nothing\n * (no throw). Call sites should not rely on vibration for critical UX.\n \n @param pattern - Duration in ms, or a pattern array as described above.\n \n @example\n * Short confirmation buzz (200 ms):\n * ```ts\n * vibrate(200);\n * ```\n \n @example\n * Double-pulse pattern: 100 ms on, 50 ms off, 100 ms on:\n * ```ts\n * vibrate([100, 50, 100]);\n * ```\n */\nexport const vibrate = (pattern: number \| number[]) => {\n if ('vibrate' in navigator) {\n navigator.vibrate(pattern);\n }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,IAAa,WAAW,YAA+B;AACrD,KAAI,aAAa,UACf,WAAU,QAAQ,QAAQ"}