flatbuffers-format API
    Preparing search index...

    Function check

    • Return true iff source is already in canonical form — i.e. running format on it would produce byte-identical output.

      Useful as a CI gate: walk a tree, call check on each .fbs file, exit non-zero if any return false. The shipped CLI's --check flag is built on this.

      Parameters

      • source: string

        The raw .fbs source.

      • options: FormatOptions = {}

        Same options as format. Defaults must match the ones you'd write with, otherwise a "well-formatted" file may falsely report unformatted.

      Returns boolean

      on invalid input (same as format).