Method binary

src/modules/string/index.ts:362–394

* Returns a [binary](https://en.wikipedia.org/wiki/Binary_number) 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.p

(
    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 '0b'
       */
      prefix?: string;
    } = {}
  )

   * @since 8.0.0
   */
  binary(
    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 '0b'
       */
      prefix?: string;
    } = {}
  ): string {
    const { prefix = '0b' } = options;

    let result = prefix;
    result += this.fromCharacters(['0', '1'], options.length ?? 1);
    return result;
  }

  /**
   * Returns an [octal](https://en.wikipedia.org/wiki/Octal) string.