Method ulid

src/modules/string/index.ts:810–825

* Returns a ULID ([Universally Unique Lexicographically Sortable Identifier](https://github.com/ulid/spec)). * * @param options The optional options object. * @param options.refDate The timestamp to encode into the ULID. * The encoded timestamp is represented by the first 10 characters o

(
    options: {
      /**
       * The date to use as reference point for the newly generated ULID encoded timestamp.
       * The encoded timestamp is represented by the first 10 characters of the result.
       *
       * @default faker.defaultRefDate()
       */
      refDate?: string | Date | number;
    } = {}
  )

   * @since 9.1.0
   */
  ulid(
    options: {
      /**
       * The date to use as reference point for the newly generated ULID encoded timestamp.
       * The encoded timestamp is represented by the first 10 characters of the result.
       *
       * @default faker.defaultRefDate()
       */
      refDate?: string | Date | number;
    } = {}
  ): string {
    const { refDate = this.faker.defaultRefDate() } = options;
    const date = toDate(refDate);

    return dateToBase32(date) + this.fromCharacters(CROCKFORDS_BASE32, 16);
  }

  /**
   * Generates a [Nano ID](https://github.com/ai/nanoid).