Magpie HTML - v0.1.3
    Preparing search index...

    Interface PluckResponse

    Enhanced Response with pluck-specific properties.

    Extends standard Response with additional metadata about the request. All standard Response properties and methods are available.

    interface PluckResponse {
        finalUrl: string;
        originalUrl: string;
        redirectChain: string[];
        detectedEncoding: string;
        timing: {
            start: number;
            end: number;
            duration: number;
            redirectDuration?: number;
        };
        textUtf8(): Promise<string>;
    }

    Hierarchy

    • Response
      • PluckResponse
    Index

    Properties

    finalUrl originalUrl redirectChain detectedEncoding timing

    Methods

    textUtf8

    Properties

    finalUrl: string

    Final URL after following redirects.

    originalUrl: string

    Original request URL.

    redirectChain: string[]

    Array of redirect URLs (excluding original and final).

    detectedEncoding: string

    Detected character encoding.

    'utf-8', 'windows-1252', 'iso-8859-1'
    timing: {
        start: number;
        end: number;
        duration: number;
        redirectDuration?: number;
    }

    Request timing information.

    Type Declaration

    • start: number

      Request start timestamp (milliseconds since epoch)

    • end: number

      Request end timestamp (milliseconds since epoch)

    • duration: number

      Total duration in milliseconds

    • OptionalredirectDuration?: number

      Time spent in redirects (milliseconds)

    Methods

    • Get response body as UTF-8 text.

      Returns Promise<string>

      UTF-8 decoded text

      Unlike standard text(), this guarantees UTF-8 output regardless of the source encoding. Uses detected encoding to decode properly.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods