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

Author: FranckFreiburger

docs/api/README.md

@@ -42,7 +42,7 @@
 
 Ƭ  **CustomBlockCallback**: (component: [ModuleExport](interfaces/moduleexport.md)) => void
 
-*Defined in [types.ts:69](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L69)*
+*Defined in [types.ts:69](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L69)*
 
 CustomBlockCallback function type
 
@@ -52,17 +52,17 @@ ___
 
 Ƭ  **LoadModule**: (path: string, options: [Options](interfaces/options.md)) => Promise<[ModuleExport](interfaces/moduleexport.md)\>
 
-*Defined in [types.ts:335](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L335)*
+*Defined in [types.ts:335](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L335)*
 
 ## Variables
 
 ### version
 
 • `Const` **version**: string = process.env.VERSION
 
-*Defined in [tools.ts:39](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/tools.ts#L39)*
+*Defined in [tools.ts:39](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/tools.ts#L39)*
 
-*Defined in [index.ts:11](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/index.ts#L11)*
+*Defined in [index.ts:11](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/index.ts#L11)*
 
 the version of the library (process.env.VERSION is set by webpack, at compile-time)
 
@@ -72,15 +72,15 @@ ___
 
 • `Const` **vueVersion**: string
 
-*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/createSFCModule.ts#L4)*
+*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/createSFCModule.ts#L4)*
 
 ## Functions
 
 ### createSFCModule
 
 ▸ **createSFCModule**(`source`: string, `filename`: string, `options`: [Options](interfaces/options.md), `loadModule`: [LoadModule](README.md#loadmodule)): Promise<[ModuleExport](interfaces/moduleexport.md)\>
 
-*Defined in [createSFCModule.ts:3](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/createSFCModule.ts#L3)*
+*Defined in [createSFCModule.ts:3](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/createSFCModule.ts#L3)*
 
 #### Parameters:
 
@@ -99,7 +99,7 @@ ___
 
 ▸ **loadModule**(`path`: string, `options_?`: [Options](interfaces/options.md)): Promise<[ModuleExport](interfaces/moduleexport.md)\>
 
-*Defined in [index.ts:109](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/index.ts#L109)*
+*Defined in [index.ts:109](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/index.ts#L109)*
 
 This is the main function.
 This function is intended to be used only to load the entry point of your application.
@@ -153,7 +153,7 @@ A Promise of the component
 
 ▪ `Const` **defaultPathHandlers**: object
 
-*Defined in [index.ts:56](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/index.ts#L56)*
+*Defined in [index.ts:56](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/index.ts#L56)*
 
 Default implementation of PathHandlers
 

docs/api/interfaces/cache.md

@@ -21,7 +21,7 @@
 
 ▸ **get**(`key`: string): Promise<string\>
 
-*Defined in [types.ts:19](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L19)*
+*Defined in [types.ts:19](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L19)*
 
 #### Parameters:
 
@@ -37,7 +37,7 @@ ___
 
 ▸ **set**(`key`: string, `value`: string): Promise<void\>
 
-*Defined in [types.ts:20](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L20)*
+*Defined in [types.ts:20](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L20)*
 
 #### Parameters:
 

docs/api/interfaces/customblock.md

@@ -24,20 +24,20 @@ A custom block
 
 •  **attrs**: Record<string, string \| true\>
 
-*Defined in [types.ts:78](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L78)*
+*Defined in [types.ts:78](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L78)*
 
 ___
 
 ### content
 
 •  **content**: string
 
-*Defined in [types.ts:77](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L77)*
+*Defined in [types.ts:77](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L77)*
 
 ___
 
 ### type
 
 •  **type**: string
 
-*Defined in [types.ts:76](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L76)*
+*Defined in [types.ts:76](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L76)*

docs/api/interfaces/file.md

@@ -23,12 +23,12 @@ Represents a file content and the extension name.
 
 •  **content**: string
 
-*Defined in [types.ts:62](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L62)*
+*Defined in [types.ts:62](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L62)*
 
 ___
 
 ### extname
 
 •  **extname**: string
 
-*Defined in [types.ts:63](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L63)*
+*Defined in [types.ts:63](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L63)*

docs/api/interfaces/module.md

@@ -22,4 +22,4 @@ This just represents a loaded js module
 
 •  **exports**: [ModuleExport](moduleexport.md)
 
-*Defined in [types.ts:96](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L96)*
+*Defined in [types.ts:96](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L96)*

docs/api/interfaces/modulehandler.md

@@ -15,7 +15,7 @@ see [additionalModuleHandlers](options.md#additionalmodulehandlers)
 
 ▸ (`source`: string, `path`: string, `options`: [Options](options.md)): Promise<[ModuleExport](moduleexport.md)\>
 
-*Defined in [types.ts:52](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L52)*
+*Defined in [types.ts:52](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L52)*
 
 Used by the library when it does not know how to handle a given file type (eg. `.json` files).
 see [additionalModuleHandlers](options.md#additionalmodulehandlers)

docs/api/interfaces/options.md

@@ -33,7 +33,7 @@
 
 • `Optional` **additionalBabelPlugins**: any[]
 
-*Defined in [types.ts:215](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L215)*
+*Defined in [types.ts:215](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L215)*
 
 Additional babel plugins. [TBD]
 
@@ -48,7 +48,7 @@ ___
 
 • `Optional` **additionalModuleHandlers**: Record<string, [ModuleHandler](modulehandler.md)\>
 
-*Defined in [types.ts:222](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L222)*
+*Defined in [types.ts:222](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L222)*
 
 Additional module type handlers. see [ModuleHandler](modulehandler.md)
 
@@ -58,7 +58,7 @@ ___
 
 • `Optional` **compiledCache**: [Cache](cache.md)
 
-*Defined in [types.ts:262](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L262)*
+*Defined in [types.ts:262](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L262)*
 
 [get](cache.md#get)() and [set](cache.md#set)() functions of this object are called when the lib needs to save or load already compiled code. get and set functions must return a `Promise` (or can be `async`).
 Since compilation consume a lot of CPU, is is always a good idea to provide this object.
@@ -102,7 +102,7 @@ ___
 
 • `Optional` **delimiters**: [string, string]
 
-*Defined in [types.ts:204](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L204)*
+*Defined in [types.ts:204](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L204)*
 
 Sets the delimiters used for text interpolation within the template.
 Typically this is used to avoid conflicting with server-side frameworks that also use mustache syntax.
@@ -146,7 +146,7 @@ ___
 
 • `Optional` **moduleCache**: Record<string, [Module](module.md)\>
 
-*Defined in [types.ts:121](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L121)*
+*Defined in [types.ts:121](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L121)*
 
 Initial cache that will contain resolved dependencies. All new modules go here.
 `vue` must initially be contained in this object.
@@ -170,7 +170,7 @@ ___
 
 •  **pathHandlers**: [PathHandlers](pathhandlers.md)
 
-*Defined in [types.ts:308](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L308)*
+*Defined in [types.ts:308](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L308)*
 
 Abstact path handling
 
@@ -180,7 +180,7 @@ Abstact path handling
 
 ▸ **addStyle**(`style`: string, `scopeId`: string \| undefined): void
 
-*Defined in [types.ts:164](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L164)*
+*Defined in [types.ts:164](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L164)*
 
 Called by the library when CSS style must be added in the HTML document.
 
@@ -212,7 +212,7 @@ ___
 
 ▸ `Optional`**customBlockHandler**(`block`: [CustomBlock](customblock.md), `filename`: string, `options`: [Options](options.md)): Promise<[CustomBlockCallback](../README.md#customblockcallback) \| undefined\>
 
-*Defined in [types.ts:330](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L330)*
+*Defined in [types.ts:330](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L330)*
 
 Called for each custom block.
 
@@ -249,7 +249,7 @@ ___
 
 ▸ **getFile**(`path`: string): Promise<[File](file.md)\>
 
-*Defined in [types.ts:142](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L142)*
+*Defined in [types.ts:142](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L142)*
 
 Called by the library when it needs a file.
 
@@ -282,7 +282,7 @@ ___
 
 ▸ `Optional`**loadModule**(`path`: string, `options`: [Options](options.md)): Promise<[Module](module.md) \| undefined\>
 
-*Defined in [types.ts:301](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L301)*
+*Defined in [types.ts:301](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L301)*
 
 Called when the lib requires a module. Do return `undefined` to let the library handle this.
 
@@ -315,7 +315,7 @@ ___
 
 ▸ `Optional`**log**(`type`: string, ...`data`: any[]): void
 
-*Defined in [types.ts:280](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L280)*
+*Defined in [types.ts:280](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L280)*
 
 Called by the library when there is somthing to log (eg. scripts compilation errors, template compilation errors, template compilation  tips, style compilation errors, ...)
 

docs/api/interfaces/pathhandlers.md

@@ -21,7 +21,7 @@
 
 ▸ **extname**(`filepath`: string): string
 
-*Defined in [types.ts:25](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L25)*
+*Defined in [types.ts:25](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L25)*
 
 #### Parameters:
 
@@ -37,7 +37,7 @@ ___
 
 ▸ **resolve**(`absoluteFilepath`: string, `dependencyPath`: string): string
 
-*Defined in [types.ts:29](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/d3200d4/src/types.ts#L29)*
+*Defined in [types.ts:29](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/87b69d5/src/types.ts#L29)*
 
 #### Parameters: