@pokt-network/pocket-js/dist/rpc/models/input/relay-payload.d.ts

Pocket-js core package with the main functionalities to interact with the Pocket Network.

export declare type RelayHeaders = Record<string, string>;
/**
 *
 *
 * @class RelayPayload
 */
export declare class RelayPayload {
    /**
     *
     * Creates a RelayPayload object using a JSON string
     * @param {string} json - JSON string.
     * @returns {RelayPayload} - RelayPayload object.
     * @memberof RelayPayload
     */
    static fromJSON(json: string): RelayPayload;
    readonly data: string;
    readonly method: string;
    readonly path: string;
    readonly headers?: RelayHeaders | null;
    /**
     * Relay Payload.
     * @constructor
     * @param {string} data - The actual data string for the external chain.
     * @param {string} method - The http CRUD method.
     * @param {string} path - The REST pathx.
     * @param {RelayHeaders} headers - Http headers.
     */
    constructor(data: string, method: string, path: string, headers: RelayHeaders | null);
    /**
     *
     * Creates a JSON object with the RelayPayload properties
     * @returns {JSON} - JSON Object.
     * @memberof RelayPayload
     */
    toJSON(): {
        data: string;
        method: string;
        path: string;
        headers: Record<string, string> | null | undefined;
    };
    /**
     *
     * Check if the RelayPayload object is valid
     * @returns {boolean} - True or false.
     * @memberof RelayPayload
     */
    isValid(): boolean;
}