chore(docs): v0.8.1 API docs & examples

Author: Franck Freiburger

docs/api/README.md

@@ -45,7 +45,9 @@
 
 Ƭ  **AbstractPath**: { toString: () => string  }
 
-*Defined in [types.ts:29](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L29)*
+*Defined in [types.ts:32](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L32)*
+
+An abstract way to specify a path. It could be a simple string or a object like an URL. An AbstractPath must always be convertible to a string.
 
 #### Type declaration:
 
@@ -59,7 +61,7 @@ ___
 
 Ƭ  **Cache**: { get: (key: string) => Promise<string\> ; set: (key: string, value: string) => Promise<void\>  }
 
-*Defined in [types.ts:20](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L20)*
+*Defined in [types.ts:20](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L20)*
 
 #### Type declaration:
 
@@ -74,15 +76,15 @@ ___
 
 Ƭ  **ContentData**: string \| ArrayBuffer
 
-*Defined in [types.ts:71](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L71)*
+*Defined in [types.ts:71](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L71)*
 
 ___
 
 ### CustomBlock
 
 Ƭ  **CustomBlock**: { attrs: Record<string, string \| true\> ; content: string ; type: string  }
 
-*Defined in [types.ts:109](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L109)*
+*Defined in [types.ts:109](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L109)*
 
 A custom block
 
@@ -100,7 +102,7 @@ ___
 
 Ƭ  **CustomBlockCallback**: (component: [ModuleExport](README.md#moduleexport)) => void
 
-*Defined in [types.ts:103](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L103)*
+*Defined in [types.ts:103](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L103)*
 
 CustomBlockCallback function type
 
@@ -110,7 +112,7 @@ ___
 
 Ƭ  **File**: { getContentData: (asBinary: Boolean) => Promise<[ContentData](README.md#contentdata)\> ; type: string  }
 
-*Defined in [types.ts:77](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L77)*
+*Defined in [types.ts:77](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L77)*
 
 Represents a file content and the extension name.
 
@@ -127,15 +129,15 @@ ___
 
 Ƭ  **LangProcessor**: (source: string, preprocessOptions?: any) => Promise<string\> \| string
 
-*Defined in [types.ts:399](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L399)*
+*Defined in [types.ts:399](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L399)*
 
 ___
 
 ### Module
 
 Ƭ  **Module**: { exports: [ModuleExport](README.md#moduleexport)  }
 
-*Defined in [types.ts:129](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L129)*
+*Defined in [types.ts:129](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L129)*
 
 This just represents a loaded js module
 
@@ -151,15 +153,15 @@ ___
 
 Ƭ  **ModuleCacheId**: string
 
-*Defined in [types.ts:26](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L26)*
+*Defined in [types.ts:26](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L26)*
 
 ___
 
 ### ModuleExport
 
 Ƭ  **ModuleExport**: {}
 
-*Defined in [types.ts:123](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L123)*
+*Defined in [types.ts:123](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L123)*
 
 This just represents a loaded js module exports
 
@@ -169,12 +171,13 @@ ___
 
 Ƭ  **ModuleHandler**: (type: string, getContentData: File[\"getContentData\"], path: [AbstractPath](README.md#abstractpath), options: [Options](README.md#options)) => Promise<[ModuleExport](README.md#moduleexport) \| null\>
 
-*Defined in [types.ts:68](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L68)*
+*Defined in [types.ts:68](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L68)*
+
+Used by the library when it needs to handle a does not know how to handle a given file type (eg. `.json` files).
 
-Used by the library when it does not know how to handle a given file type (eg. `.json` files).
-see [[moduleHandlers]]
+**`param`** The type of the file. It can be anything, but must be '.vue', '.js' or '.mjs' for vue, js and esm files.
 
-**`param`** The content of the file
+**`param`** The method to get the content data of a file (text or binary). see [[ File['getContentData'] ]]
 
 **`param`** The path of the file
 
@@ -184,9 +187,6 @@ see [[moduleHandlers]]
 
 ```javascript
 	...
-	moduleHandlers: {
-		'.json': (source, path, options) => JSON.parse(source),
-	}
 	...
 ```
 
@@ -196,7 +196,7 @@ ___
 
 Ƭ  **Options**: { additionalBabelParserPlugins?: babel\_ParserPlugin[] ; additionalBabelPlugins?: Record<string, any\> ; compiledCache?: [Cache](README.md#cache) ; delimiters?: [string, string] ; handleModule?: [ModuleHandler](README.md#modulehandler) ; moduleCache: Record<[ModuleCacheId](README.md#modulecacheid), LoadingType<[ModuleExport](README.md#moduleexport)\> \| [ModuleExport](README.md#moduleexport)\> ; pathResolve: [PathResolve](README.md#pathresolve) ; addStyle: (style: string, scopeId: string \| undefined) => void ; customBlockHandler?: (block: [CustomBlock](README.md#customblock), filename: [AbstractPath](README.md#abstractpath), options: [Options](README.md#options)) => Promise<[CustomBlockCallback](README.md#customblockcallback) \| undefined\> ; getFile: (path: [AbstractPath](README.md#abstractpath)) => Promise<[File](README.md#file) \| [ContentData](README.md#contentdata)\> ; getResource: (pathCx: [PathContext](README.md#pathcontext), options: [Options](README.md#options)) => [Resource](README.md#resource) ; loadModule?: (path: [AbstractPath](README.md#abstractpath), options: [Options](README.md#options)) => Promise<[ModuleExport](README.md#moduleexport) \| undefined\> ; log?: (type: string, ...data: any[]) => void  }
 
-*Defined in [types.ts:140](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L140)*
+*Defined in [types.ts:140](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L140)*
 
 #### Type declaration:
 
@@ -222,7 +222,7 @@ ___
 
 Ƭ  **PathContext**: { refPath: [AbstractPath](README.md#abstractpath) ; relPath: [AbstractPath](README.md#abstractpath)  }
 
-*Defined in [types.ts:38](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L38)*
+*Defined in [types.ts:41](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L41)*
 
 A PathContext represents a path (relPath) relative to an abolute path (refPath)
 Note that relPath is not necessary relative, but it is, relPath is relative to refPath.
@@ -240,7 +240,7 @@ ___
 
 Ƭ  **PathResolve**: (pathCx: [PathContext](README.md#pathcontext)) => [AbstractPath](README.md#abstractpath)
 
-*Defined in [types.ts:47](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L47)*
+*Defined in [types.ts:50](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L50)*
 
 relative to absolute module path resolution
 
@@ -250,15 +250,15 @@ ___
 
 Ƭ  **Resource**: { getContent: () => Promise<[File](README.md#file)\> ; id: [ModuleCacheId](README.md#modulecacheid) ; path: [AbstractPath](README.md#abstractpath)  }
 
-*Defined in [types.ts:88](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/types.ts#L88)*
+*Defined in [types.ts:88](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/types.ts#L88)*
 
 Represents a resource.
 
 #### Type declaration:
 
 Name | Type | Description |
 ------ | ------ | ------ |
-`getContent` | () => Promise<[File](README.md#file)\> | asynchronously get the content of the resource |
+`getContent` | () => Promise<[File](README.md#file)\> | asynchronously get the content of the resource. Once you got the content, you can asynchronously get the data through the getContentData(asBinary) method. |
 `id` | [ModuleCacheId](README.md#modulecacheid) | 'abstract' unique id of the resource. This id is used as the key of the [[Options.moduleCache]] |
 `path` | [AbstractPath](README.md#abstractpath) | file path of the resource |
 
@@ -268,9 +268,9 @@ Name | Type | Description |
 
 • `Const` **version**: string = process.env.VERSION
 
-*Defined in [tools.ts:53](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/tools.ts#L53)*
+*Defined in [tools.ts:53](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/tools.ts#L53)*
 
-*Defined in [index.ts:26](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/index.ts#L26)*
+*Defined in [index.ts:26](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/index.ts#L26)*
 
 the version of the library (process.env.VERSION is set by webpack, at compile-time)
 
@@ -280,15 +280,15 @@ ___
 
 • `Const` **vueVersion**: string
 
-*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/createSFCModule.ts#L4)*
+*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/createSFCModule.ts#L4)*
 
 ## Functions
 
 ### buildTemplateProcessor
 
 ▸ **buildTemplateProcessor**(`processor`: [LangProcessor](README.md#langprocessor)): object
 
-*Defined in [index.ts:179](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/index.ts#L179)*
+*Defined in [index.ts:179](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/index.ts#L179)*
 
 Convert a function to template processor interface (consolidate)
 
@@ -310,7 +310,7 @@ ___
 
 ▸ **createSFCModule**(`source`: string, `filename`: [AbstractPath](README.md#abstractpath), `options`: [Options](README.md#options)): Promise<[ModuleExport](README.md#moduleexport)\>
 
-*Defined in [createSFCModule.ts:3](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/createSFCModule.ts#L3)*
+*Defined in [createSFCModule.ts:3](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/createSFCModule.ts#L3)*
 
 #### Parameters:
 
@@ -328,7 +328,7 @@ ___
 
 ▸ **defaultGetResource**(`pathCx`: [PathContext](README.md#pathcontext), `options`: [Options](README.md#options)): [Resource](README.md#resource)
 
-*Defined in [index.ts:76](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/index.ts#L76)*
+*Defined in [index.ts:76](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/index.ts#L76)*
 
 Default getResource implementation
 by default, getContent() use the file extension as file type.
@@ -348,7 +348,7 @@ ___
 
 ▸ **defaultHandleModule**(`type`: string, `getContentData`: File[\"getContentData\"], `path`: [AbstractPath](README.md#abstractpath), `options`: [Options](README.md#options)): Promise<[ModuleExport](README.md#moduleexport) \| null\>
 
-*Defined in [tools.ts:372](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/tools.ts#L372)*
+*Defined in [tools.ts:372](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/tools.ts#L372)*
 
 Default implementation of handleModule
 
@@ -369,7 +369,7 @@ ___
 
 ▸ `Const`**defaultPathResolve**(`__namedParameters`: { refPath: [AbstractPath](README.md#abstractpath) ; relPath: [AbstractPath](README.md#abstractpath)  }): string \| [AbstractPath](README.md#abstractpath)
 
-*Defined in [index.ts:53](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/index.ts#L53)*
+*Defined in [index.ts:53](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/index.ts#L53)*
 
 Default resolve implementation
 resolve() should handle 3 situations :
@@ -391,7 +391,7 @@ ___
 
 ▸ **loadModule**(`path`: [AbstractPath](README.md#abstractpath), `options?`: [Options](README.md#options)): Promise<[ModuleExport](README.md#moduleexport)\>
 
-*Defined in [index.ts:152](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/index.ts#L152)*
+*Defined in [index.ts:152](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/index.ts#L152)*
 
 This is the main function.
 This function is intended to be used only to load the entry point of your application.
@@ -445,7 +445,7 @@ ___
 
 ▸ **loadModuleInternal**(`pathCx`: [PathContext](README.md#pathcontext), `options`: [Options](README.md#options)): Promise<[ModuleExport](README.md#moduleexport)\>
 
-*Defined in [tools.ts:260](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/04817e0/src/tools.ts#L260)*
+*Defined in [tools.ts:260](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/9dfc5b1/src/tools.ts#L260)*
 
 #### Parameters: