Class FileParser<S>

constructor

• new FileParser<S extends SchemaNode<any, string>>(
      schema: S,
      attach_to?: HTMLElement | undefined,
  ): FileParser<S>

  Type Parameters

  • S extends SchemaNode<any, string>

  Parameters

  • schema: S

    which schema class to base the decoding and encoding on

  • attach_to: HTMLElement | undefined = document.body

    where do you wish to attach the loader_input html element? if undefined, it will not get attached to the DOM. default = document.body

  Returns FileParser<S>

Readonlyloader_input

Readonlydownloader_link

Readonlyfile_reader

Readonlyschema

loaded_data

parseFile

• parseFile(file: File): Promise<NonNullable<S["value"]>>

  parse and decode the provided file

  Parameters

  • file: File

  Returns Promise<NonNullable<S["value"]>>

parseBuffer

• parseBuffer(buf: ArrayBuffer): NonNullable<S["value"]>

  parse and decode the provided buffer

  Parameters

  • buf: ArrayBuffer

  Returns NonNullable<S["value"]>

clearLoadedData

• clearLoadedData(): void

  clear the loaded data to free memory

  Returns void

encodeObject

• encodeObject(value: NonNullable<S["value"]>): Uint8Array<ArrayBuffer>

  encode the provided javascript object into a Uint8Array bytes array using this.schema.encode

  Parameters

  • value: NonNullable<S["value"]>

  Returns Uint8Array<ArrayBuffer>

downloadObject

• downloadObject(value: NonNullable<S["value"]>, filename?: string): void

  download the provided javascript object as a binary blob, by encoding it based on this.schema.encode

  Parameters

  • value: NonNullable<S["value"]>
  • filename: string = ""

  Returns void