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

Author: FranckFreiburger

docs/api/README.md

@@ -10,6 +10,7 @@
 
 * [Cache](interfaces/cache.md)
 * [CustomBlock](interfaces/customblock.md)
+* [File](interfaces/file.md)
 * [Module](interfaces/module.md)
 * [ModuleExport](interfaces/moduleexport.md)
 * [ModuleHandler](interfaces/modulehandler.md)
@@ -19,7 +20,6 @@
 ### Type aliases
 
 * [CustomBlockCallback](README.md#customblockcallback)
-* [File](README.md#file)
 * [LoadModule](README.md#loadmodule)
 
 ### Variables
@@ -42,37 +42,27 @@
 
 Ƭ  **CustomBlockCallback**: (component: [ModuleExport](interfaces/moduleexport.md)) => void
 
-*Defined in [types.ts:66](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L66)*
+*Defined in [types.ts:69](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L69)*
 
 CustomBlockCallback function type
 
 ___
 
-### File
-
-Ƭ  **File**: string \| { content: string ; extname: string  }
-
-*Defined in [types.ts:60](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L60)*
-
-Represents the content of the file or the content and the extension name.
-
-___
-
 ### LoadModule
 
 Ƭ  **LoadModule**: (path: string, options: [Options](interfaces/options.md)) => Promise<[ModuleExport](interfaces/moduleexport.md)\>
 
-*Defined in [types.ts:332](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L332)*
+*Defined in [types.ts:335](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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/e87df0d/src/tools.ts#L39)*
+*Defined in [tools.ts:39](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/tools.ts#L39)*
 
-*Defined in [index.ts:11](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/index.ts#L11)*
+*Defined in [index.ts:11](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/index.ts#L11)*
 
 the version of the library (process.env.VERSION is set by webpack, at compile-time)
 
@@ -82,15 +72,15 @@ ___
 
 • `Const` **vueVersion**: string
 
-*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/createSFCModule.ts#L4)*
+*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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/e87df0d/src/createSFCModule.ts#L3)*
+*Defined in [createSFCModule.ts:3](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/createSFCModule.ts#L3)*
 
 #### Parameters:
 
@@ -109,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/e87df0d/src/index.ts#L109)*
+*Defined in [index.ts:109](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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.
@@ -119,7 +109,7 @@ If for some reason you need to use it in your components, be sure to share at le
 
 Name | Type | Default value | Description |
 ------ | ------ | ------ | ------ |
-`path` | string | - | The path of the `.vue` file. If path is not a path (eg. an string ID), your [getFile](interfaces/options.md#getfile) function must return a [File](README.md#file) object. |
+`path` | string | - | The path of the `.vue` file. If path is not a path (eg. an string ID), your [getFile](interfaces/options.md#getfile) function must return a [File](interfaces/file.md) object. |
 `options_` | [Options](interfaces/options.md) | throwNotDefined('options') | - |
 
 **Returns:** Promise<[ModuleExport](interfaces/moduleexport.md)\>
@@ -163,7 +153,7 @@ A Promise of the component
 
 ▪ `Const` **defaultPathHandlers**: object
 
-*Defined in [index.ts:56](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/index.ts#L56)*
+*Defined in [index.ts:56](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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/e87df0d/src/types.ts#L19)*
+*Defined in [types.ts:19](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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/e87df0d/src/types.ts#L20)*
+*Defined in [types.ts:20](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:75](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L75)*
+*Defined in [types.ts:78](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L78)*
 
 ___
 
 ### content
 
 •  **content**: string
 
-*Defined in [types.ts:74](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L74)*
+*Defined in [types.ts:77](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L77)*
 
 ___
 
 ### type
 
 •  **type**: string
 
-*Defined in [types.ts:73](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L73)*
+*Defined in [types.ts:76](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L76)*

docs/api/interfaces/file.md

@@ -0,0 +1,34 @@
+**[vue3-sfc-loader](../README.md)**
+
+> [Globals](../README.md) / File
+
+# Interface: File
+
+Represents a file content and the extension name.
+
+## Hierarchy
+
+* **File**
+
+## Index
+
+### Properties
+
+* [content](file.md#content)
+* [extname](file.md#extname)
+
+## Properties
+
+### content
+
+•  **content**: string
+
+*Defined in [types.ts:62](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L62)*
+
+___
+
+### extname
+
+•  **extname**: string
+
+*Defined in [types.ts:63](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:93](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L93)*
+*Defined in [types.ts:96](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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/e87df0d/src/types.ts#L52)*
+*Defined in [types.ts:52](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:212](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L212)*
+*Defined in [types.ts:215](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L215)*
 
 Additional babel plugins. [TBD]
 
@@ -48,7 +48,7 @@ ___
 
 • `Optional` **additionalModuleHandlers**: Record<string, [ModuleHandler](modulehandler.md)\>
 
-*Defined in [types.ts:219](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L219)*
+*Defined in [types.ts:222](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:259](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L259)*
+*Defined in [types.ts:262](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:201](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L201)*
+*Defined in [types.ts:204](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:118](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L118)*
+*Defined in [types.ts:121](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:305](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L305)*
+*Defined in [types.ts:308](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:161](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L161)*
+*Defined in [types.ts:164](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:327](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L327)*
+*Defined in [types.ts:330](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L330)*
 
 Called for each custom block.
 
@@ -247,9 +247,9 @@ ___
 
 ### getFile
 
-▸ **getFile**(`path`: string): Promise<[File](../README.md#file)\>
+▸ **getFile**(`path`: string): Promise<[File](file.md)\>
 
-*Defined in [types.ts:139](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L139)*
+*Defined in [types.ts:142](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L142)*
 
 Called by the library when it needs a file.
 
@@ -259,7 +259,7 @@ Name | Type | Description |
 ------ | ------ | ------ |
 `path` | string | The path of the file |
 
-**Returns:** Promise<[File](../README.md#file)\>
+**Returns:** Promise<[File](file.md)\>
 
 a Promise of the file content (UTF-8)
 
@@ -282,7 +282,7 @@ ___
 
 ▸ `Optional`**loadModule**(`path`: string, `options`: [Options](options.md)): Promise<[Module](module.md) \| undefined\>
 
-*Defined in [types.ts:298](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L298)*
+*Defined in [types.ts:301](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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:277](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L277)*
+*Defined in [types.ts:280](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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/e87df0d/src/types.ts#L25)*
+*Defined in [types.ts:25](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/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/e87df0d/src/types.ts#L29)*
+*Defined in [types.ts:29](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e2255e9/src/types.ts#L29)*
 
 #### Parameters: