...

Text file src/github.com/google/flatbuffers/tests/ts/reflection/field.d.ts

Documentation: github.com/google/flatbuffers/tests/ts/reflection

     1import * as flatbuffers from 'flatbuffers';
     2import { KeyValue, KeyValueT } from '../reflection/key-value.js';
     3import { Type, TypeT } from '../reflection/type.js';
     4export declare class Field implements flatbuffers.IUnpackableObject<FieldT> {
     5    bb: flatbuffers.ByteBuffer | null;
     6    bb_pos: number;
     7    __init(i: number, bb: flatbuffers.ByteBuffer): Field;
     8    static getRootAsField(bb: flatbuffers.ByteBuffer, obj?: Field): Field;
     9    static getSizePrefixedRootAsField(bb: flatbuffers.ByteBuffer, obj?: Field): Field;
    10    name(): string | null;
    11    name(optionalEncoding: flatbuffers.Encoding): string | Uint8Array | null;
    12    type(obj?: Type): Type | null;
    13    id(): number;
    14    mutate_id(value: number): boolean;
    15    offset(): number;
    16    mutate_offset(value: number): boolean;
    17    defaultInteger(): bigint;
    18    mutate_default_integer(value: bigint): boolean;
    19    defaultReal(): number;
    20    mutate_default_real(value: number): boolean;
    21    deprecated(): boolean;
    22    mutate_deprecated(value: boolean): boolean;
    23    required(): boolean;
    24    mutate_required(value: boolean): boolean;
    25    key(): boolean;
    26    mutate_key(value: boolean): boolean;
    27    attributes(index: number, obj?: KeyValue): KeyValue | null;
    28    attributesLength(): number;
    29    documentation(index: number): string;
    30    documentation(index: number, optionalEncoding: flatbuffers.Encoding): string | Uint8Array;
    31    documentationLength(): number;
    32    optional(): boolean;
    33    mutate_optional(value: boolean): boolean;
    34    /**
    35     * Number of padding octets to always add after this field. Structs only.
    36     */
    37    padding(): number;
    38    mutate_padding(value: number): boolean;
    39    static getFullyQualifiedName(): string;
    40    static startField(builder: flatbuffers.Builder): void;
    41    static addName(builder: flatbuffers.Builder, nameOffset: flatbuffers.Offset): void;
    42    static addType(builder: flatbuffers.Builder, typeOffset: flatbuffers.Offset): void;
    43    static addId(builder: flatbuffers.Builder, id: number): void;
    44    static addOffset(builder: flatbuffers.Builder, offset: number): void;
    45    static addDefaultInteger(builder: flatbuffers.Builder, defaultInteger: bigint): void;
    46    static addDefaultReal(builder: flatbuffers.Builder, defaultReal: number): void;
    47    static addDeprecated(builder: flatbuffers.Builder, deprecated: boolean): void;
    48    static addRequired(builder: flatbuffers.Builder, required: boolean): void;
    49    static addKey(builder: flatbuffers.Builder, key: boolean): void;
    50    static addAttributes(builder: flatbuffers.Builder, attributesOffset: flatbuffers.Offset): void;
    51    static createAttributesVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset;
    52    static startAttributesVector(builder: flatbuffers.Builder, numElems: number): void;
    53    static addDocumentation(builder: flatbuffers.Builder, documentationOffset: flatbuffers.Offset): void;
    54    static createDocumentationVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset;
    55    static startDocumentationVector(builder: flatbuffers.Builder, numElems: number): void;
    56    static addOptional(builder: flatbuffers.Builder, optional: boolean): void;
    57    static addPadding(builder: flatbuffers.Builder, padding: number): void;
    58    static endField(builder: flatbuffers.Builder): flatbuffers.Offset;
    59    unpack(): FieldT;
    60    unpackTo(_o: FieldT): void;
    61}
    62export declare class FieldT implements flatbuffers.IGeneratedObject {
    63    name: string | Uint8Array | null;
    64    type: TypeT | null;
    65    id: number;
    66    offset: number;
    67    defaultInteger: bigint;
    68    defaultReal: number;
    69    deprecated: boolean;
    70    required: boolean;
    71    key: boolean;
    72    attributes: (KeyValueT)[];
    73    documentation: (string)[];
    74    optional: boolean;
    75    padding: number;
    76    constructor(name?: string | Uint8Array | null, type?: TypeT | null, id?: number, offset?: number, defaultInteger?: bigint, defaultReal?: number, deprecated?: boolean, required?: boolean, key?: boolean, attributes?: (KeyValueT)[], documentation?: (string)[], optional?: boolean, padding?: number);
    77    pack(builder: flatbuffers.Builder): flatbuffers.Offset;
    78}

View as plain text