index.d.ts

// custom types required by the typescript compiler

declare module "\*.svg" {
  const content: string;
  export default content;
}

declare module 'buffer-layout' {
	// TODO: remove `any`.
  export class Layout<T = any> {
    span: number;
    property?: string;

    constructor(span: number, property?: string);

    decode(b: Buffer, offset?: number): T;
    encode(src: T, b: Buffer, offset?: number): number;
    getSpan(b: Buffer, offset?: number): number;
    replicate(name: string): this;
  }
	// TODO: remove any.
  export class Structure<T = any> extends Layout<T> {
		span: any;
	}
  export function greedy(
    elementSpan?: number,
    property?: string,
  ): Layout<number>;
  export function offset<T>(
    layout: Layout<T>,
    offset?: number,
    property?: string,
  ): Layout<T>;
  export function u8(property?: string): Layout<number>;
  export function u16(property?: string): Layout<number>;
  export function u24(property?: string): Layout<number>;
  export function u32(property?: string): Layout<number>;
  export function u40(property?: string): Layout<number>;
  export function u48(property?: string): Layout<number>;
  export function nu64(property?: string): Layout<number>;
  export function u16be(property?: string): Layout<number>;
  export function u24be(property?: string): Layout<number>;
  export function u32be(property?: string): Layout<number>;
  export function u40be(property?: string): Layout<number>;
  export function u48be(property?: string): Layout<number>;
  export function nu64be(property?: string): Layout<number>;
  export function s8(property?: string): Layout<number>;
  export function s16(property?: string): Layout<number>;
  export function s24(property?: string): Layout<number>;
  export function s32(property?: string): Layout<number>;
  export function s40(property?: string): Layout<number>;
  export function s48(property?: string): Layout<number>;
  export function ns64(property?: string): Layout<number>;
  export function s16be(property?: string): Layout<number>;
  export function s24be(property?: string): Layout<number>;
  export function s32be(property?: string): Layout<number>;
  export function s40be(property?: string): Layout<number>;
  export function s48be(property?: string): Layout<number>;
  export function ns64be(property?: string): Layout<number>;
  export function f32(property?: string): Layout<number>;
  export function f32be(property?: string): Layout<number>;
  export function f64(property?: string): Layout<number>;
  export function f64be(property?: string): Layout<number>;
  export function struct<T>(
    fields: Layout<any>[],
    property?: string,
    decodePrefixes?: boolean,
  ): Layout<T>;
  export function bits(
    word: Layout<number>,
    msb?: boolean,
    property?: string,
  ): any;
  export function seq<T>(
    elementLayout: Layout<T>,
    count: number | Layout<number>,
    property?: string,
  ): Layout<T[]>;
  export function union(
    discr: Layout<any>,
    defaultLayout?: any,
    property?: string,
  ): any;
  export function unionLayoutDiscriminator(
    layout: Layout<any>,
    property?: string,
  ): any;
  export function blob(
    length: number | Layout<number>,
    property?: string,
  ): Layout<Buffer>;
  export function cstr(property?: string): Layout<string>;
  export function utf8(maxSpan: number, property?: string): Layout<string>;
}