ComponentEmbedError

Thrown when a component tree breaks a rule of Discord's component embed format, or when your own code throws while the tree is read. Discord drops an invalid payload and shows the Open Graph card instead, without reporting an error anywhere.

class ComponentEmbedError extends Error

try {
    toComponentEmbed(<GuidePreview page={page} />);
} catch (error) {
    if (error instanceof ComponentEmbedError && error.code === 'ReadFailed') console.error(error.cause);
    throw error;
}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the ComponentEmbedError class

ComponentEmbedError(
    code: ComponentEmbedErrorCode,
    message: string,
    options?: ErrorOptions
)

Showing members with Protected visibility and higher.

Properties

code
name

code

public readonly code: ComponentEmbedErrorCode

name

public readonly name

Loading…

Classdiscord-component-embedv0.1.0