ComponentEmbedError

Thrown when a component tree breaks a rule of Discord's component embed format, or when your own code throws while the package reads the tree. Read code to tell which. Discord drops an invalid payload and falls back to the Open Graph card. The card you see is your only signal.

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

Which rule the tree broke.

public readonly code: ComponentEmbedErrorCode

name

public readonly name

Loading…

Classdiscord-component-embedv0.2.2