@chris.troutner/ipfs-message-port-server/dist/src/block.d.ts

IPFS server library for exposing IPFS node over message port

export type IPFS = import('@chris.troutner/ipfs-core-types').IPFS;
export type CID = import('cids');
export type EncodedError = import('@chris.troutner/ipfs-message-port-protocol/src/error').EncodedError;
export type Block = import('@chris.troutner/ipfs-message-port-protocol/src/block').Block;
export type EncodedCID = import('@chris.troutner/ipfs-message-port-protocol/src/cid').EncodedCID;
export type EncodedBlock = import('@chris.troutner/ipfs-message-port-protocol/src/block').EncodedBlock;
export type EncodedRmResult = import('@chris.troutner/ipfs-message-port-protocol/src/block').EncodedRmResult;
export type PutOptions = import('@chris.troutner/ipfs-core-types/src/block').PutOptions;
export class BlockService {
    /**
     * @param {IPFS} ipfs
     */
    constructor(ipfs: IPFS);
    ipfs: import("@chris.troutner/ipfs-core-types").IPFS;
    /**
     * @typedef {Object} GetResult
     * @property {EncodedBlock} block
     * @property {Transferable[]} transfer
     *
     * @typedef {Object} GetQuery
     * @property {EncodedCID} cid
     * @property {number} [timeout]
     * @property {AbortSignal} [query.signal]
     *
     * @param {GetQuery} query
     * @returns {Promise<GetResult>}
     */
    get(query: {
        cid: EncodedCID;
        timeout?: number | undefined;
        signal?: AbortSignal | undefined;
    }): Promise<{
        block: EncodedBlock;
        transfer: Transferable[];
    }>;
    /**
     * @typedef {Object} PutResult
     * @property {EncodedBlock} block
     * @property {Transferable[]} transfer
     *
     * @typedef {Object} PutQuery
     * @property {EncodedBlock|Uint8Array} block
     * @property {EncodedCID|undefined} [cid]
     *
     * Stores input as an IPFS block.
     *
     * @param {PutOptions & PutQuery} query
     * @returns {Promise<PutResult>}
     */
    put(query: import("@chris.troutner/ipfs-core-types/src/block").PutOptions & {
        block: EncodedBlock | Uint8Array;
        /**
         * Stores input as an IPFS block.
         */
        cid?: EncodedCID | undefined;
    }): Promise<{
        block: EncodedBlock;
        transfer: Transferable[];
    }>;
    /**
     * @typedef {Object} RmQuery
     * @property {EncodedCID[]} cids
     * @property {boolean} [force]
     * @property {boolean} [quiet]
     * @property {number} [timeout]
     * @property {AbortSignal} [signal]
     *
     * Remove one or more IPFS block(s).
     * @param {RmQuery} query
     * @returns {Promise<EncodedRmResult[]>}
     */
    rm(query: {
        cids: EncodedCID[];
        force?: boolean | undefined;
        quiet?: boolean | undefined;
        timeout?: number | undefined;
        /**
         * Remove one or more IPFS block(s).
         */
        signal?: AbortSignal | undefined;
    }): Promise<EncodedRmResult[]>;
    /**
     * @typedef {Object} StatQuery
     * @property {EncodedCID} cid
     * @property {number} [timeout]
     * @property {AbortSignal} [signal]
     *
     * @typedef {Object} EncodedStatResult
     * @property {EncodedCID} cid
     * @property {number} size
     *
     * Gets information of a raw IPFS block.
     *
     * @param {StatQuery} query
     * @returns {Promise<EncodedStatResult>}
     */
    stat(query: {
        cid: EncodedCID;
        timeout?: number | undefined;
        signal?: AbortSignal | undefined;
    }): Promise<{
        cid: EncodedCID;
        /**
         * Gets information of a raw IPFS block.
         */
        size: number;
    }>;
}
//# sourceMappingURL=block.d.ts.map