Class ModPermissionsBF

bitField

constructor

[iterator]

• "[iterator]"(): Generator<
      | "backup_app"
      | "commit_app"
      | "edit_ram"
      | "logs_app"
      | "restart_app"
      | "start_app"
      | "status_app"
      | "stop_app",
      void,
      unknown,
  >

  Returns Generator<
      | "backup_app"
      | "commit_app"
      | "edit_ram"
      | "logs_app"
      | "restart_app"
      | "start_app"
      | "status_app"
      | "stop_app",
      void,
      unknown,
  >

add

• add(
      ...bits: BitFieldResolvable<
          | "backup_app"
          | "commit_app"
          | "edit_ram"
          | "logs_app"
          | "restart_app"
          | "start_app"
          | "status_app"
          | "stop_app",
          number,
      >[],
  ): this

  Adds bits to these ones.

  Parameters

  • ...bits: BitFieldResolvable<
        | "backup_app"
        | "commit_app"
        | "edit_ram"
        | "logs_app"
        | "restart_app"
        | "start_app"
        | "status_app"
        | "stop_app",
        number,
    >[]

    Bits to add

  Returns this

  These bits or new BitField if the instance is frozen.

any

• any(
      ...bits: BitFieldResolvable<
          | "backup_app"
          | "commit_app"
          | "edit_ram"
          | "logs_app"
          | "restart_app"
          | "start_app"
          | "status_app"
          | "stop_app",
          number,
      >[],
  ): boolean

  Checks whether the bitfield has a bit, or any of multiple bits.

  Parameters

  • ...bits: BitFieldResolvable<
        | "backup_app"
        | "commit_app"
        | "edit_ram"
        | "logs_app"
        | "restart_app"
        | "start_app"
        | "status_app"
        | "stop_app",
        number,
    >[]

    Bit(s) to check for

  Returns boolean

equals

• equals(
      ...bits: BitFieldResolvable<
          | "backup_app"
          | "commit_app"
          | "edit_ram"
          | "logs_app"
          | "restart_app"
          | "start_app"
          | "status_app"
          | "stop_app",
          number,
      >[],
  ): boolean

  Checks if this bitfield equals another

  Parameters

  • ...bits: BitFieldResolvable<
        | "backup_app"
        | "commit_app"
        | "edit_ram"
        | "logs_app"
        | "restart_app"
        | "start_app"
        | "status_app"
        | "stop_app",
        number,
    >[]

    Bit(s) to check for

  Returns boolean

freeze

• freeze(): Readonly<this>

  Freezes these bits, making them immutable.

  Returns Readonly<this>

has

• has(
      ...bits: BitFieldResolvable<
          | "backup_app"
          | "commit_app"
          | "edit_ram"
          | "logs_app"
          | "restart_app"
          | "start_app"
          | "status_app"
          | "stop_app",
          number,
      >[],
  ): boolean

  Checks whether the bitfield has a bit, or multiple bits.

  Parameters

  • ...bits: BitFieldResolvable<
        | "backup_app"
        | "commit_app"
        | "edit_ram"
        | "logs_app"
        | "restart_app"
        | "start_app"
        | "status_app"
        | "stop_app",
        number,
    >[]

    Bit(s) to check for

  Returns boolean

missing

• missing(
      ...bits: BitFieldResolvable<
          | "backup_app"
          | "commit_app"
          | "edit_ram"
          | "logs_app"
          | "restart_app"
          | "start_app"
          | "status_app"
          | "stop_app",
          number,
      >[],
  ): (
      | "backup_app"
      | "commit_app"
      | "edit_ram"
      | "logs_app"
      | "restart_app"
      | "start_app"
      | "status_app"
      | "stop_app"
  )[]

  Gets all given bits that are missing from the bitfield.

  Parameters

  • ...bits: BitFieldResolvable<
        | "backup_app"
        | "commit_app"
        | "edit_ram"
        | "logs_app"
        | "restart_app"
        | "start_app"
        | "status_app"
        | "stop_app",
        number,
    >[]

    Bit(s) to check for

  Returns (
      | "backup_app"
      | "commit_app"
      | "edit_ram"
      | "logs_app"
      | "restart_app"
      | "start_app"
      | "status_app"
      | "stop_app"
  )[]

remove

• remove(
      ...bits: BitFieldResolvable<
          | "backup_app"
          | "commit_app"
          | "edit_ram"
          | "logs_app"
          | "restart_app"
          | "start_app"
          | "status_app"
          | "stop_app",
          number,
      >[],
  ): this

  Removes bits from these.

  Parameters

  • ...bits: BitFieldResolvable<
        | "backup_app"
        | "commit_app"
        | "edit_ram"
        | "logs_app"
        | "restart_app"
        | "start_app"
        | "status_app"
        | "stop_app",
        number,
    >[]

    Bits to remove

  Returns this

  These bits or new BitField if the instance is frozen.

serialize

• serialize(): Record<
      | "backup_app"
      | "commit_app"
      | "edit_ram"
      | "logs_app"
      | "restart_app"
      | "start_app"
      | "status_app"
      | "stop_app",
      boolean,
  >

  Gets an object mapping field names to a boolean indicating whether the bit is available.

  Returns Record<
      | "backup_app"
      | "commit_app"
      | "edit_ram"
      | "logs_app"
      | "restart_app"
      | "start_app"
      | "status_app"
      | "stop_app",
      boolean,
  >

set

• set(
      ...bits: BitFieldResolvable<
          | "backup_app"
          | "commit_app"
          | "edit_ram"
          | "logs_app"
          | "restart_app"
          | "start_app"
          | "status_app"
          | "stop_app",
          number,
      >[],
  ): this

  Replace the bits with these.

  Parameters

  • ...bits: BitFieldResolvable<
        | "backup_app"
        | "commit_app"
        | "edit_ram"
        | "logs_app"
        | "restart_app"
        | "start_app"
        | "status_app"
        | "stop_app",
        number,
    >[]

    bits to set

  Returns this

  These bits or new BitField if the instance is frozen.

toArray

• toArray(): (
      | "backup_app"
      | "commit_app"
      | "edit_ram"
      | "logs_app"
      | "restart_app"
      | "start_app"
      | "status_app"
      | "stop_app"
  )[]

  Gets an Array of bitfield names based on the bits available.

  Returns (
      | "backup_app"
      | "commit_app"
      | "edit_ram"
      | "logs_app"
      | "restart_app"
      | "start_app"
      | "status_app"
      | "stop_app"
  )[]

toJSON

• toJSON(): number

  Returns number

toString

• toString(): `${number}`

  Returns `${number}`

valueOf

• valueOf(): number

  Returns number

Staticresolve

• resolve<S extends string, N extends number | bigint>(
      bit: BitFieldResolvable<S, N>,
  ): N

  Resolves bitfields to their numeric form.

  Type Parameters

  • S extends string
  • N extends number | bigint

  Parameters

  • bit: BitFieldResolvable<S, N>

    bit(s) to resolve

  Returns N