From ac2660158e19ee346528df77c9064d6957d53c54 Mon Sep 17 00:00:00 2001 From: dazuaz Date: Wed, 15 Jun 2022 13:17:56 -0400 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8cfdd10..4164b1f 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,36 @@ module.exports = { } ``` +### Typescript + + + +```typescript +//declare a module to your type definitions files *.d.ts +interface ResponsiveImageOutput { + src: string + srcSet: string + placeholder: string | undefined + images: { path: string; width: number; height: number }[] + width: number + height: number + toString: () => string +} + +declare module '*!rl' { + const src: ResponsiveImageOutput + export default src +} +``` + +``` +import responsiveImage from 'img/myImage.jpg?sizes[]=300,sizes[]=600,sizes[]=1024,sizes[]=2048!rl'; +import responsiveImageWebp from 'img/myImage.jpg?sizes[]=300,sizes[]=600,sizes[]=1024,sizes[]=2048&format=webp!rl'; +... +``` + +--- + Then import images in your JavaScript files: ```js @@ -161,7 +191,7 @@ ReactDOM.render( ) ``` -You can also use JSON5 notation: +You can also use [JSON5](https://json5.org/) notation: ```