Skip to content

docs: name print options type #1408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ishaanlabs-gg wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −12
Open

docs: name print options type #1408

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions plugins/plugin-print/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,22 @@ const PrintOptionsSchema = z.object({
maxWidth: z.number().optional(),
/** the boundary height to draw in */
maxHeight: z.number().optional(),
/** a callback for when complete that ahs the end co-ordinates of the text */
/** a callback for when complete that has the end co-ordinates of the text */
cb: z
.function(z.tuple([z.object({ x: z.number(), y: z.number() })]))
.optional(),
});

export type PrintOptions = z.infer<typeof PrintOptionsSchema>;

/**
* Options for {@link print}.
*/
export type PrintOptionsWithFont<I extends JimpClass> = PrintOptions & {
/** the BMFont instance */
font: BmFont<I>;
};

function xOffsetBasedOnAlignment<I extends JimpClass>(
font: BmFont<I>,
line: string,
Expand Down Expand Up @@ -133,16 +141,8 @@ export const methods = {
* image.print({ font, x: 10, y: 10, text: "Hello world!" });
* ```
*/
print<I extends JimpClass>(
image: I,
{
font,
...options
}: PrintOptions & {
/** the BMFont instance */
font: BmFont<I>;
}
) {
print<I extends JimpClass>(image: I, options: PrintOptionsWithFont<I>) {
const { font, ...printOptions } = options;
let {
// eslint-disable-next-line prefer-const
x,
Expand All @@ -154,7 +154,7 @@ export const methods = {
maxHeight = Infinity,
// eslint-disable-next-line prefer-const
cb = () => {},
} = PrintOptionsSchema.parse(options);
} = PrintOptionsSchema.parse(printOptions);

let alignmentX: HorizontalAlign;
let alignmentY: VerticalAlign;
Expand Down