README - Tldraw — ContextQMD

@tldraw/validate

Validation functions used by tldraw.

These are especially useful when used in conjunction with our shapes to validate their schemas.

For example, for TLImageShape we have the following to help make sure the properties on a shape are consistent:

tsx

export const imageShapeProps: RecordProps<TLImageShape> = {
	w: T.nonZeroNumber,
	h: T.nonZeroNumber,
	playing: T.boolean,
	url: T.linkUrl,
	assetId: assetIdValidator.nullable(),
	crop: ImageShapeCrop.nullable(),
	flipX: T.boolean,
	flipY: T.boolean,
}

We also use the validation functions for API requests. For example, to check that the query is valid:

tsx

const queryValidator = T.object({
	w: T.string.optional(),
	q: T.string.optional(),
})

queryValidator.validate(request.query)

Documentation

Documentation for the most recent release can be found on tldraw.dev/docs, including reference docs. Our release notes can be found here.

For more agent-friendly docs, see our LLMs.txt.

A DOCS.md file is included alongside this README in the published package, with detailed API documentation and usage examples.

Contribution

Found a bug? Please submit an issue.

License

This project is licensed under the MIT License found here. The tldraw SDK is provided under the tldraw license.

Trademarks

Contact

Find us on Twitter/X at @tldraw.

Community

Have questions, comments or feedback? Join our discord. For the latest news and release notes, visit tldraw.dev.