Skip to main content
Version: v1

DocumentPostCreateError Class

Error returned by createContainer(createNewSummary, resolvedUrl, logger, clientIsSummarizer) when an error is thrown in documentPostCreateCallback(documentId, creationToken). It is the consumer's responsibility to ensure that any state related to container creation is appropriately cleaned up in the event of failure. This includes the document itself, which will have been created by the time this error was thrown.

Signature

export declare class DocumentPostCreateError extends Error

Extends: Error

Remarks

TODO: examples of suggested actions for recovery. - How would a user delete the created document? - What would a retry pattern look like here?

Constructors

Constructor Description
(constructor)(innerError) Constructs a new instance of the DocumentPostCreateError class

Properties

Property Type Description
name
stack string | undefined

Constructor Details

(constructor)

Constructs a new instance of the DocumentPostCreateError class

Signature

constructor(
innerError: Error);

Parameters

Parameter Type Description
innerError Error

Property Details

name

Signature

readonly name = "DocumentPostCreateError";

stack

Signature

get stack(): string | undefined;

Type: string | undefined