@flowscripter/io-plugin-http
    Preparing search index...

    Class HttpIOProvider

    HTTP/HTTPS source/sink provider. Every key is a full URL addressing one entry: reads are GET (ranged reads use a Range header), writes stream the body of a PUT or POST, properties come from HEAD, and delete is DELETE. There is no generic way to list, create containers, set properties or upload in parts over HTTP, so those members are omitted.

    Implements

    • IOProvider<PayloadKind.Js>
    Index
    constructor
    kind
    [asyncDispose] delete getProperties getReadableStream getWritableStream

    • Parameters

      • config: {
            bearerToken?: string;
            headers?: { name: string; value: string }[];
            method?: "PUT" | "POST";
            password?: string;
            username?: string;
        }
      • fetchFn: Fetch = fetch

      Returns HttpIOProvider

    kind: Js = PayloadKind.Js

    The single payload kind this provider natively produces/consumes.

    • Returns Promise<void>

    • Parameters

      • url: string

      Returns Promise<void>

    • Parameters

      • url: string

      Returns Promise<EntryProperties>

    • Parameters

      • url: string

      Returns Promise<StreamHandle<Js> & RangeReadable<Js>>

    • Opens a writable stream. With resume, the provider re-checks what was actually committed and continues from there, reporting the real resume position as startOffset (bytes).

      Parameters

      • url: string

      Returns Promise<StreamHandle<Js>>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods