Classdiscord-component-embedv0.4.1

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,
    { path, ...options }?,
    input?: ErrorOptions & { path?: readonly string[] }
)

Showing members with Protected visibility and higher.

code

Which rule the tree broke.

public readonly code: ComponentEmbedErrorCode

name

public readonly name

path

The steps from the root to the component that broke a rule, like ['Container', 'PostCard', 'Section 2']. Your own components appear by name. A number marks a component written next to others with the same name. The path is empty when the problem is the whole embed, like its size. For a tree from fromPayload, the steps are JSON keys and array indexes counted from 0, like ['component', 'components', '1'].

public readonly path: readonly string[]