DOIP Client Library - JavaScript Version
    Preparing search index...

    Class InDoipSegment

    Represents a segment of an InDoipMessage. Each segment may consist of JSON or arbitrary bytes.

    For advanced usage. In most cases, the input of DoipRequest can be provided, and the output of DoipResponse can be accessed, more simply as JSON or one of the various JavaScript types for representing bytes.

    Implements

    • Body
    Index

    Properties

    isJson: boolean

    Accessors

    • get body(): ReadableStream<Uint8Array<ArrayBuffer>>

      Returns ReadableStream<Uint8Array<ArrayBuffer>>

    • get bodyUsed(): boolean

      Returns boolean

    Methods

    • Parameters

      • isJson: undefined | null | boolean
      • json: Json

      Returns InDoipSegment

    • Parameters

      • isJson: undefined | null | boolean
      • body:
            | undefined
            | null
            | string
            | ArrayBuffer
            | ArrayBufferView<ArrayBuffer>
            | Blob
            | ReadableStream<Uint8Array<ArrayBuffer>>

      Returns InDoipSegment

    • Returns Promise<ArrayBuffer>

    • Returns Promise<Uint8Array<ArrayBuffer>>

    • Returns Promise<Blob>

    • Returns Promise<Json>

    • Returns Promise<string>

    • Returns Promise<FormData>

    • In situations where we can't just use ReadableStream -- namely, browsers which don't support ReadableStream requests in fetch -- we may want to know whether we had a ReadableStream or a Blob (in particular, a File) in order to construct a request with the minimum of reading things into memory.

      Returns Blob | ReadableStream<Uint8Array<ArrayBuffer>>

    • Returns Promise<void>