@pnp/sp
Version:
pnp - provides a fluent api for working with SharePoint REST
37 lines • 1.35 kB
TypeScript
import { TimelinePipe } from "@pnp/core";
import { ISPQueryable } from "./spqueryable.js";
declare module "./fi" {
interface SPFI {
/**
* Creates a batch behavior and associated execute function
*
*/
batched(props?: ISPBatchProps): [SPFI, () => Promise<void>];
}
}
declare module "./webs/types" {
interface _Web {
/**
* Creates a batch behavior and associated execute function
*
*/
batched(props?: ISPBatchProps): [IWeb, () => Promise<void>];
}
}
interface ISPBatchProps {
/**
* Controls the headers copied from the original request into the batched request, applied to all items
* default: /Accept|Content-Type|IF-Match/i
*/
headersCopyPattern?: RegExp;
}
/**
* Creates a batched version of the supplied base, meaning that all chained fluent operations from the new base are part of the batch
*
* @param base The base from which to initialize the batch
* @param props Any properties used to initialize the batch functionality
* @returns A tuple of [behavior used to assign objects to the batch, the execute function used to resolve the batch requests]
*/
export declare function createBatch(base: ISPQueryable, props?: ISPBatchProps): [TimelinePipe, () => Promise<void>];
export {};
//# sourceMappingURL=batching.d.ts.map