@h3ravel/support 0.12.0 → 0.13.0

package/dist/index.d.cts

@@ -40,7 +40,7 @@ type XGeneric<V = TGeneric, T = any> = {
   [key: string]: T;
 } & V;
 declare namespace Arr_d_exports {
-  export { alternate, chunk, collapse, combine, find, first, flatten, forget, isEmpty, isNotEmpty, last, pop, prepend, range, reverse, shift, take };
+  export { alternate, chunk, collapse, combine, find, first, flatten, forget, isEmpty, isNotEmpty, last, pop, prepend, range, reverse, shift, take, wrap };
 }
 /**
  * Splits an array into chunks of a specified size.
@@ -95,6 +95,13 @@ declare const shift: <T>(arr: T[]) => [T, T[]];
 declare const range: (size: number, startAt?: number) => number[];
 /** Flatten multi-dimensional arrays into single level. */
 declare const flatten: <T>(arr: T[]) => T[];
+/**
+ * If the given value is not an array and not null, wrap it in one.
+ *
+ * @param  {Array}  value
+ * @return array
+ */
+declare const wrap: <A>(value: A | A[]) => A[];
 declare namespace Crypto_d_exports {
   export { base64Decode, base64Encode, caesarCipher, checksum, hash, hmac, random, randomColor, randomPassword, randomSecure, secureToken, uuid, verifyChecksum, xor };
 }
@@ -346,6 +353,108 @@ declare const setNested: (obj: Record<string, any>, key: string, value: any) =>
  */
 declare const slugifyKeys: <T extends object>(obj: T, only?: string[], separator?: string) => KeysToSnakeCase<T>;
 //#endregion
+//#region src/Helpers/Time.d.ts
+declare function format(date: ConfigType, fmt: string): string;
+declare const TimeClass: {
+  new (date?: dayjs.ConfigType): Dayjs;
+} & typeof Dayjs;
+declare class DateTime extends TimeClass {
+  private instance;
+  constructor(config?: ConfigType);
+  /**
+   * Start time of a specific unit.
+   *
+   * @returns
+   */
+  start(unit?: OpUnitType): dayjs.Dayjs;
+  /**
+   * End time of a specific unit.
+   *
+   * @returns
+   */
+  end(unit?: OpUnitType): dayjs.Dayjs;
+  /**
+   * Get the first day of the month of the given date
+   *
+   * @returns
+   */
+  firstDayOfMonth(): DateTime;
+  carbonFormat(template?: string | undefined): string;
+  /**
+   * Get the last day of the month of the given date
+   *
+   * @returns
+   */
+  lastDayOfMonth(): DateTime;
+  /**
+   * Get a random time between the specified hour and minute.
+   *
+   * @param startHour
+   * @param startMinute
+   * @param endHour
+   * @param endMinute
+   * @returns
+   */
+  randomTime(startHour?: number, startMinute?: number, endHour?: number, endMinute?: number): DateTime;
+  /**
+   * Create a date for a given timestamp.
+   *
+   * @param timestamp - Unix timestamp
+   *
+   * @return {Date} object
+   */
+  static fromTimestamp(timestamp: number): Date;
+  /**
+   * Get current time instance.
+   *
+   * @returns Current time
+   */
+  static now(): DateTime;
+  /**
+   * Parse the time
+   *
+   * @param date
+   * @returns
+   */
+  static parse(date: dayjs.ConfigType): DateTime;
+  /**
+   * Get the formatted date according to the string of tokens passed in.
+   *
+   * To escape characters, wrap them in square brackets (e.g. [MM]).
+   *
+   * @param time - current time
+   * @param template - time format
+   */
+  static format(time?: ConfigType, template?: string | undefined): string;
+  /**
+   * Get the difference in days from today.
+   *
+   * @param time
+   * @param startHour
+   * @param startMinute
+   * @param endHour
+   * @param endMinute
+   * @returns
+   */
+  static randomTime(time?: ConfigType, startHour?: number, startMinute?: number, endHour?: number, endMinute?: number): DateTime;
+  /**
+   * Get the first day of the month of the given date
+   *
+   * @param time
+   *
+   * @returns
+   */
+  static firstDayOfMonth(time: ConfigType): DateTime;
+  /**
+   * Get the last day of the month of the given date
+   *
+   * @param time
+   *
+   * @returns
+   */
+  static lastDayOfMonth(time: ConfigType): DateTime;
+}
+//#endregion
 //#region src/Helpers/Str.d.ts
 declare enum Mode {
   MB_CASE_UPPER = 0,
@@ -2586,112 +2695,10 @@ declare class HtmlString {
  */
 declare function str(string?: string): Stringable;
 //#endregion
-//#region src/Helpers/Time.d.ts
-declare function format(date: ConfigType, fmt: string): string;
-declare const TimeClass: {
-  new (date?: dayjs.ConfigType): Dayjs;
-} & typeof Dayjs;
-declare class Time extends TimeClass {
-  private instance;
-  constructor(config?: ConfigType);
-  /**
-   * Start time of a specific unit.
-   *
-   * @returns
-   */
-  start(unit?: OpUnitType): dayjs.Dayjs;
-  /**
-   * End time of a specific unit.
-   *
-   * @returns
-   */
-  end(unit?: OpUnitType): dayjs.Dayjs;
-  /**
-   * Get the first day of the month of the given date
-   *
-   * @returns
-   */
-  firstDayOfMonth(): Time;
-  carbonFormat(template?: string | undefined): string;
-  /**
-   * Get the last day of the month of the given date
-   *
-   * @returns
-   */
-  lastDayOfMonth(): Time;
-  /**
-   * Get a random time between the specified hour and minute.
-   *
-   * @param startHour
-   * @param startMinute
-   * @param endHour
-   * @param endMinute
-   * @returns
-   */
-  randomTime(startHour?: number, startMinute?: number, endHour?: number, endMinute?: number): Time;
-  /**
-   * Create a date for a given timestamp.
-   *
-   * @param timestamp - Unix timestamp
-   *
-   * @return {Date} object
-   */
-  static fromTimestamp(timestamp: number): Date;
-  /**
-   * Get current time instance.
-   *
-   * @returns Current time
-   */
-  static now(): Time;
-  /**
-   * Parse the time
-   *
-   * @param date
-   * @returns
-   */
-  static parse(date: dayjs.ConfigType): Time;
-  /**
-   * Get the formatted date according to the string of tokens passed in.
-   *
-   * To escape characters, wrap them in square brackets (e.g. [MM]).
-   *
-   * @param time - current time
-   * @param template - time format
-   */
-  static format(time?: ConfigType, template?: string | undefined): string;
-  /**
-   * Get the difference in days from today.
-   *
-   * @param time
-   * @param startHour
-   * @param startMinute
-   * @param endHour
-   * @param endMinute
-   * @returns
-   */
-  static randomTime(time?: ConfigType, startHour?: number, startMinute?: number, endHour?: number, endMinute?: number): Time;
-  /**
-   * Get the first day of the month of the given date
-   *
-   * @param time
-   *
-   * @returns
-   */
-  static firstDayOfMonth(time: ConfigType): Time;
-  /**
-   * Get the last day of the month of the given date
-   *
-   * @param time
-   *
-   * @returns
-   */
-  static lastDayOfMonth(time: ConfigType): Time;
-}
-//#endregion
 //#region src/GlobalBootstrap.d.ts
 type CollapseStatics<T extends Record<string, any>> = { [K in keyof T]: T[K] };
 type Omitables = 'start' | 'take' | 'reverse' | 'chunk' | 'find' | 'pop' | 'end' | 'shift' | 'push' | 'at' | 'prototype' | 'concat' | 'join' | 'slice' | 'sort' | 'splice' | 'includes' | 'indexOf' | 'lastIndexOf' | 'findIndex' | 'every' | 'some' | 'forEach' | 'map' | 'filter' | 'reduce' | 'unshift' | 'flat' | 'flatMap' | 'keys' | 'fill' | 'copyWithin' | 'entries' | 'values' | 'reduceRight' | 'length' | 'of' | typeof Symbol.unscopables | typeof Symbol.iterator;
-type TakeTime = Pick<typeof Time, 'now' | 'format' | 'fromTimestamp' | 'randomTime' | 'firstDayOfMonth' | 'lastDayOfMonth' | 'parse'>;
+type TakeTime = Pick<typeof DateTime, 'now' | 'format' | 'fromTimestamp' | 'randomTime' | 'firstDayOfMonth' | 'lastDayOfMonth' | 'parse'>;
 type TakeString = Pick<typeof Str, 'after' | 'afterLast' | 'apa' | 'ascii' | 'before' | 'beforeLast' | 'between' | 'betweenFirst' | 'capitalize' | 'plural' | 'singular' | 'title'>;
 /**
  * Global helpers interface that mirrors Laravel's helpers
@@ -2702,9 +2709,9 @@ interface GlobalHelpers extends Omit<CollapseStatics<typeof Arr_d_exports>, Omit
   Str: typeof Str;
   Obj: typeof Obj_d_exports;
   Crypto: typeof Crypto_d_exports;
-  Time: typeof Time;
   Number: typeof Number_d_exports;
   DumpDie: typeof DumpDie_d_exports;
+  DateTime: typeof DateTime;
 }
 /**
  * Bootstrap the global helpers into the global scope.
@@ -2737,5 +2744,5 @@ declare function loadHelpers(target?: any): void;
  */
 declare function cleanHelpers(target?: any): void;
 //#endregion
-export { Arr_d_exports as Arr, Callback, CamelToSnakeCase, Crypto_d_exports as Crypto, DumpDie_d_exports as DumpDie, ExcerptOptions, Fallback, Function, GlobalHelpers, HtmlString, HtmlStringType, KeysToSnakeCase, Mode, Number_d_exports as Number, Obj_d_exports as Obj, SnakeToCamelCase, SnakeToTitleCase, Str, Stringable, TGeneric, Time, Value, XGeneric, abbreviate, alternate, base64Decode, base64Encode, caesarCipher, checksum, chunk, cleanHelpers, collapse, combine, dd, dot, dump, extractProperties, find, first, flatten, forget, format, getValue, hash, hmac, humanize, isEmpty, isNotEmpty, last, loadHelpers, modObj, pop, prepend, random, randomColor, randomPassword, randomSecure, range, reverse, safeDot, secureToken, setNested, shift, slugifyKeys, str, take, toBytes, toHumanTime, uuid, verifyChecksum, xor };
+export { Arr_d_exports as Arr, Callback, CamelToSnakeCase, Crypto_d_exports as Crypto, DateTime, DumpDie_d_exports as DumpDie, ExcerptOptions, Fallback, Function, GlobalHelpers, HtmlString, HtmlStringType, KeysToSnakeCase, Mode, Number_d_exports as Number, Obj_d_exports as Obj, SnakeToCamelCase, SnakeToTitleCase, Str, Stringable, TGeneric, Value, XGeneric, abbreviate, alternate, base64Decode, base64Encode, caesarCipher, checksum, chunk, cleanHelpers, collapse, combine, dd, dot, dump, extractProperties, find, first, flatten, forget, format, getValue, hash, hmac, humanize, isEmpty, isNotEmpty, last, loadHelpers, modObj, pop, prepend, random, randomColor, randomPassword, randomSecure, range, reverse, safeDot, secureToken, setNested, shift, slugifyKeys, str, take, toBytes, toHumanTime, uuid, verifyChecksum, wrap, xor };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -37,7 +37,7 @@ type XGeneric<V = TGeneric, T = any> = {
   [key: string]: T;
 } & V;
 declare namespace Arr_d_exports {
-  export { alternate, chunk, collapse, combine, find, first, flatten, forget, isEmpty, isNotEmpty, last, pop, prepend, range, reverse, shift, take };
+  export { alternate, chunk, collapse, combine, find, first, flatten, forget, isEmpty, isNotEmpty, last, pop, prepend, range, reverse, shift, take, wrap };
 }
 /**
  * Splits an array into chunks of a specified size.
@@ -92,6 +92,13 @@ declare const shift: <T>(arr: T[]) => [T, T[]];
 declare const range: (size: number, startAt?: number) => number[];
 /** Flatten multi-dimensional arrays into single level. */
 declare const flatten: <T>(arr: T[]) => T[];
+/**
+ * If the given value is not an array and not null, wrap it in one.
+ *
+ * @param  {Array}  value
+ * @return array
+ */
+declare const wrap: <A>(value: A | A[]) => A[];
 declare namespace Crypto_d_exports {
   export { base64Decode, base64Encode, caesarCipher, checksum, hash, hmac, random, randomColor, randomPassword, randomSecure, secureToken, uuid, verifyChecksum, xor };
 }
@@ -343,6 +350,108 @@ declare const setNested: (obj: Record<string, any>, key: string, value: any) =>
  */
 declare const slugifyKeys: <T extends object>(obj: T, only?: string[], separator?: string) => KeysToSnakeCase<T>;
 //#endregion
+//#region src/Helpers/Time.d.ts
+declare function format(date: ConfigType, fmt: string): string;
+declare const TimeClass: {
+  new (date?: dayjs.ConfigType): Dayjs;
+} & typeof Dayjs;
+declare class DateTime extends TimeClass {
+  private instance;
+  constructor(config?: ConfigType);
+  /**
+   * Start time of a specific unit.
+   *
+   * @returns
+   */
+  start(unit?: OpUnitType): dayjs.Dayjs;
+  /**
+   * End time of a specific unit.
+   *
+   * @returns
+   */
+  end(unit?: OpUnitType): dayjs.Dayjs;
+  /**
+   * Get the first day of the month of the given date
+   *
+   * @returns
+   */
+  firstDayOfMonth(): DateTime;
+  carbonFormat(template?: string | undefined): string;
+  /**
+   * Get the last day of the month of the given date
+   *
+   * @returns
+   */
+  lastDayOfMonth(): DateTime;
+  /**
+   * Get a random time between the specified hour and minute.
+   *
+   * @param startHour
+   * @param startMinute
+   * @param endHour
+   * @param endMinute
+   * @returns
+   */
+  randomTime(startHour?: number, startMinute?: number, endHour?: number, endMinute?: number): DateTime;
+  /**
+   * Create a date for a given timestamp.
+   *
+   * @param timestamp - Unix timestamp
+   *
+   * @return {Date} object
+   */
+  static fromTimestamp(timestamp: number): Date;
+  /**
+   * Get current time instance.
+   *
+   * @returns Current time
+   */
+  static now(): DateTime;
+  /**
+   * Parse the time
+   *
+   * @param date
+   * @returns
+   */
+  static parse(date: dayjs.ConfigType): DateTime;
+  /**
+   * Get the formatted date according to the string of tokens passed in.
+   *
+   * To escape characters, wrap them in square brackets (e.g. [MM]).
+   *
+   * @param time - current time
+   * @param template - time format
+   */
+  static format(time?: ConfigType, template?: string | undefined): string;
+  /**
+   * Get the difference in days from today.
+   *
+   * @param time
+   * @param startHour
+   * @param startMinute
+   * @param endHour
+   * @param endMinute
+   * @returns
+   */
+  static randomTime(time?: ConfigType, startHour?: number, startMinute?: number, endHour?: number, endMinute?: number): DateTime;
+  /**
+   * Get the first day of the month of the given date
+   *
+   * @param time
+   *
+   * @returns
+   */
+  static firstDayOfMonth(time: ConfigType): DateTime;
+  /**
+   * Get the last day of the month of the given date
+   *
+   * @param time
+   *
+   * @returns
+   */
+  static lastDayOfMonth(time: ConfigType): DateTime;
+}
+//#endregion
 //#region src/Helpers/Str.d.ts
 declare enum Mode {
   MB_CASE_UPPER = 0,
@@ -2583,112 +2692,10 @@ declare class HtmlString {
  */
 declare function str(string?: string): Stringable;
 //#endregion
-//#region src/Helpers/Time.d.ts
-declare function format(date: ConfigType, fmt: string): string;
-declare const TimeClass: {
-  new (date?: dayjs.ConfigType): Dayjs;
-} & typeof Dayjs;
-declare class Time extends TimeClass {
-  private instance;
-  constructor(config?: ConfigType);
-  /**
-   * Start time of a specific unit.
-   *
-   * @returns
-   */
-  start(unit?: OpUnitType): dayjs.Dayjs;
-  /**
-   * End time of a specific unit.
-   *
-   * @returns
-   */
-  end(unit?: OpUnitType): dayjs.Dayjs;
-  /**
-   * Get the first day of the month of the given date
-   *
-   * @returns
-   */
-  firstDayOfMonth(): Time;
-  carbonFormat(template?: string | undefined): string;
-  /**
-   * Get the last day of the month of the given date
-   *
-   * @returns
-   */
-  lastDayOfMonth(): Time;
-  /**
-   * Get a random time between the specified hour and minute.
-   *
-   * @param startHour
-   * @param startMinute
-   * @param endHour
-   * @param endMinute
-   * @returns
-   */
-  randomTime(startHour?: number, startMinute?: number, endHour?: number, endMinute?: number): Time;
-  /**
-   * Create a date for a given timestamp.
-   *
-   * @param timestamp - Unix timestamp
-   *
-   * @return {Date} object
-   */
-  static fromTimestamp(timestamp: number): Date;
-  /**
-   * Get current time instance.
-   *
-   * @returns Current time
-   */
-  static now(): Time;
-  /**
-   * Parse the time
-   *
-   * @param date
-   * @returns
-   */
-  static parse(date: dayjs.ConfigType): Time;
-  /**
-   * Get the formatted date according to the string of tokens passed in.
-   *
-   * To escape characters, wrap them in square brackets (e.g. [MM]).
-   *
-   * @param time - current time
-   * @param template - time format
-   */
-  static format(time?: ConfigType, template?: string | undefined): string;
-  /**
-   * Get the difference in days from today.
-   *
-   * @param time
-   * @param startHour
-   * @param startMinute
-   * @param endHour
-   * @param endMinute
-   * @returns
-   */
-  static randomTime(time?: ConfigType, startHour?: number, startMinute?: number, endHour?: number, endMinute?: number): Time;
-  /**
-   * Get the first day of the month of the given date
-   *
-   * @param time
-   *
-   * @returns
-   */
-  static firstDayOfMonth(time: ConfigType): Time;
-  /**
-   * Get the last day of the month of the given date
-   *
-   * @param time
-   *
-   * @returns
-   */
-  static lastDayOfMonth(time: ConfigType): Time;
-}
-//#endregion
 //#region src/GlobalBootstrap.d.ts
 type CollapseStatics<T extends Record<string, any>> = { [K in keyof T]: T[K] };
 type Omitables = 'start' | 'take' | 'reverse' | 'chunk' | 'find' | 'pop' | 'end' | 'shift' | 'push' | 'at' | 'prototype' | 'concat' | 'join' | 'slice' | 'sort' | 'splice' | 'includes' | 'indexOf' | 'lastIndexOf' | 'findIndex' | 'every' | 'some' | 'forEach' | 'map' | 'filter' | 'reduce' | 'unshift' | 'flat' | 'flatMap' | 'keys' | 'fill' | 'copyWithin' | 'entries' | 'values' | 'reduceRight' | 'length' | 'of' | typeof Symbol.unscopables | typeof Symbol.iterator;
-type TakeTime = Pick<typeof Time, 'now' | 'format' | 'fromTimestamp' | 'randomTime' | 'firstDayOfMonth' | 'lastDayOfMonth' | 'parse'>;
+type TakeTime = Pick<typeof DateTime, 'now' | 'format' | 'fromTimestamp' | 'randomTime' | 'firstDayOfMonth' | 'lastDayOfMonth' | 'parse'>;
 type TakeString = Pick<typeof Str, 'after' | 'afterLast' | 'apa' | 'ascii' | 'before' | 'beforeLast' | 'between' | 'betweenFirst' | 'capitalize' | 'plural' | 'singular' | 'title'>;
 /**
  * Global helpers interface that mirrors Laravel's helpers
@@ -2699,9 +2706,9 @@ interface GlobalHelpers extends Omit<CollapseStatics<typeof Arr_d_exports>, Omit
   Str: typeof Str;
   Obj: typeof Obj_d_exports;
   Crypto: typeof Crypto_d_exports;
-  Time: typeof Time;
   Number: typeof Number_d_exports;
   DumpDie: typeof DumpDie_d_exports;
+  DateTime: typeof DateTime;
 }
 /**
  * Bootstrap the global helpers into the global scope.
@@ -2734,5 +2741,5 @@ declare function loadHelpers(target?: any): void;
  */
 declare function cleanHelpers(target?: any): void;
 //#endregion
-export { Arr_d_exports as Arr, Callback, CamelToSnakeCase, Crypto_d_exports as Crypto, DumpDie_d_exports as DumpDie, ExcerptOptions, Fallback, Function, GlobalHelpers, HtmlString, HtmlStringType, KeysToSnakeCase, Mode, Number_d_exports as Number, Obj_d_exports as Obj, SnakeToCamelCase, SnakeToTitleCase, Str, Stringable, TGeneric, Time, Value, XGeneric, abbreviate, alternate, base64Decode, base64Encode, caesarCipher, checksum, chunk, cleanHelpers, collapse, combine, dd, dot, dump, extractProperties, find, first, flatten, forget, format, getValue, hash, hmac, humanize, isEmpty, isNotEmpty, last, loadHelpers, modObj, pop, prepend, random, randomColor, randomPassword, randomSecure, range, reverse, safeDot, secureToken, setNested, shift, slugifyKeys, str, take, toBytes, toHumanTime, uuid, verifyChecksum, xor };
+export { Arr_d_exports as Arr, Callback, CamelToSnakeCase, Crypto_d_exports as Crypto, DateTime, DumpDie_d_exports as DumpDie, ExcerptOptions, Fallback, Function, GlobalHelpers, HtmlString, HtmlStringType, KeysToSnakeCase, Mode, Number_d_exports as Number, Obj_d_exports as Obj, SnakeToCamelCase, SnakeToTitleCase, Str, Stringable, TGeneric, Value, XGeneric, abbreviate, alternate, base64Decode, base64Encode, caesarCipher, checksum, chunk, cleanHelpers, collapse, combine, dd, dot, dump, extractProperties, find, first, flatten, forget, format, getValue, hash, hmac, humanize, isEmpty, isNotEmpty, last, loadHelpers, modObj, pop, prepend, random, randomColor, randomPassword, randomSecure, range, reverse, safeDot, secureToken, setNested, shift, slugifyKeys, str, take, toBytes, toHumanTime, uuid, verifyChecksum, wrap, xor };
 //# sourceMappingURL=index.d.ts.map