Mika Scraper / TextCraftClientOptions

Interface: TextCraftClientOptions

The TextCraftClientOptions interface defines optional configuration settings that can be provided when instantiating the TextCraftClient.

Properties

baseURL?

Type: string
Description: The base URL for the text crafting service. This URL is used to set the endpoint for API requests made by the client.
Defined in: src/textcraft/TextCraftClient.ts:58

defaultStyle?

Type: Partial<{ fontStyle?: string; fontStyle2?: string; fontStyle3?: string; fontSize?: string; fontSize2?: string; fontSize3?: string; fontColour?: string; fontColour2?: string; fontColour3?: string; borderColour?: string; borderColour2?: string; borderColour3?: string; dropShadow?: boolean; glossy?: boolean; lighting?: boolean; glitterBorder?: boolean; }>
Description: A set of optional default styling properties for text formatting. This can include various font styles, sizes, colors, and enhancements such as border colors and effects.
Defined in: src/textcraft/TextCraftClient.ts:59

Example


const options: TextCraftClientOptions = {
    baseURL: "https://api.example.com",
    defaultStyle: {
        fontStyle: "italic",
        fontSize: "16px",
        fontColour: "#000000",
        dropShadow: true,
    },
};

Diagram: Mika Scraper