Method octal

src/modules/string/index.ts:414–449

* Returns an [octal](https://en.wikipedia.org/wiki/Octal) string. * * @param options The optional options object. * @param options.length The length of the string (excluding the prefix) to generate either as a fixed length or as a length range. Defaults to `1`. * @param options.prefix Pr

(
    options: {
      /**
       * The length of the string (excluding the prefix) to generate either as a fixed length or as a length range.
       *
       * @default 1
       */
      length?:
        | number
        | {
            /**
             * The minimum length of the string (excluding the prefix) to generate.
             */
            min: number;
            /**
             * The maximum length of the string (excluding the prefix) to generate.
             */
            max: number;
          };
      /**
       * Prefix for the generated number.
       *
       * @default '0o'
       */
      prefix?: string;
    } = {}
  )

   * @since 8.0.0
   */
  octal(
    options: {
      /**
       * The length of the string (excluding the prefix) to generate either as a fixed length or as a length range.
       *
       * @default 1
       */
      length?:
        | number
        | {
            /**
             * The minimum length of the string (excluding the prefix) to generate.
             */
            min: number;
            /**
             * The maximum length of the string (excluding the prefix) to generate.
             */
            max: number;
          };
      /**
       * Prefix for the generated number.
       *
       * @default '0o'
       */
      prefix?: string;
    } = {}
  ): string {
    const { prefix = '0o' } = options;

    let result = prefix;
    result += this.fromCharacters(
      ['0', '1', '2', '3', '4', '5', '6', '7'],
      options.length ?? 1
    );
    return result;
  }

  /**
   * Returns a [hexadecimal](https://en.wikipedia.org/wiki/Hexadecimal) string.