@types/ffi-napi/node-ffi-napi-buffer.d.ts

TypeScript definitions for ffi-napi

// DefinitelyTyped: partial

interface Buffer {
    /** Shorthand for `ref.address`. */
    address(): number;
    /** Shorthand for `ref.deref`. */
    deref(): any;
    /** Shorthand for `ref.isNull`. */
    isNull(): boolean;
    /** Shorthand for `ref.readCString`. */
    readCString(offset?: number): string;
    /** Shorthand for `ref.readInt64BE`. */
    readInt64BE(offset?: number): string;
    /** Shorthand for `ref.readInt64LE`. */
    readInt64LE(offset?: number): string;
    /** Shorthand for `ref.readObject`. */
    readObject(offset?: number): string;
    /** Shorthand for `ref.readPointer`. */
    readPointer(offset?: number): string;
    /** Shorthand for `ref.readUInt64BE`. */
    readUInt64BE(offset?: number): string;
    /** Shorthand for `ref.readUInt64LE`. */
    readUInt64LE(offset?: number): string;
    /** Shorthand for `ref.ref`. */
    ref(): Buffer;
    /** Shorthand for `ref.reinterpret`. */
    reinterpret(size: number, offset?: number): Buffer;
    /** Shorthand for `ref.reinterpretUntilZeros`. */
    reinterpretUntilZeros(size: number, offset?: number): Buffer;
    /** Shorthand for `ref.writeCString`. */
    writeCString(offset: number, input: string, encoding?: string): void;
    /** Shorthand for `ref.writeInt64BE`. */
    writeInt64BE(offset: number, input: number | string): any;
    /** Shorthand for `ref.writeInt64LE`. */
    writeInt64LE(offset: number, input: number | string): any;
    /** Shorthand for `ref.writeObject`. */
    writeObject(offset: number, object: object): void;
    /** Shorthand for `ref.writePointer`. */
    writePointer(offset: number, pointer: Buffer): void;
    /** Shorthand for `ref.writeUInt64BE`. */
    writeUInt64BE(offset: number, input: number | string): any;
    /** Shorthand for `ref.writeUInt64LE`. */
    writeUInt64LE(offset: number, input: number | string): any;

    /**
     * Generate string for inspecting.
     * String includes the hex-encoded memory address of the Buffer instance.
     */
    inspect(): string;
}