@httpx/assert/dist/string.guards.d.cts

Assertions and typeguards

import { S as StringNonEmpty, P as ParsableSafeInt, a as ParsableStrictIsoDateZ } from './string.types-CUAzdQ54.cjs';
import './opaque.types-Dc5fGlwR.cjs';

declare const isStringNonEmpty: (v: unknown) => v is StringNonEmpty;
declare const isParsableSafeInt: (v: unknown) => v is ParsableSafeInt;
/**
 * Check if a value is a string that contains an ISO-8601 date time in 'YYYY-MM-DDTHH:mm:ss.sssZ'
 * format (UTC+0 / time). This check allow the value to be safely passed to `new Date()`or `Date.parse()`
 * without parser or timezone mis-interpretations. 'T' and 'Z' checks are done in a case-insensitive way.
 *
 * ```typescript
 * isParsableStrictIsoDateZ('2023-12-28T23:37:31.653Z'); // ✅ true
 * isParsableStrictIsoDateZ('2023-12-29T23:37:31.653z'); // ✅ true  (case-insensitive works)
 * isParsableStrictIsoDateZ('2023-12-28T23:37:31.653');  // ❌ false (missing 'Z')
 * isParsableStrictIsoDateZ('2023-02-29T23:37:31.653Z'); // ❌ false (No 29th february in 2023)
 *
 * const dateStr = '2023-12-29T23:37:31.653Z';
 * if (isParsableStrictIsoDateZ(dateStr)) {
 *   const date = new Date(dateStr);
 *   const timestampNumber = Date.parse(dateStr);
 * } else {
 *   // invalid format
 * }
 * ```
 *
 * @see https://en.wikipedia.org/wiki/ISO_8601
 * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
 * @see https://en.wikipedia.org/wiki/Coordinated_Universal_Time
 */
declare const isParsableStrictIsoDateZ: (v: unknown) => v is ParsableStrictIsoDateZ;

export { isParsableSafeInt, isParsableStrictIsoDateZ, isStringNonEmpty };