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

Author: FranckFreiburger

docs/api/README.md

@@ -9,7 +9,9 @@
 ### Interfaces
 
 * [Cache](interfaces/cache.md)
+* [CustomBlock](interfaces/customblock.md)
 * [Module](interfaces/module.md)
+* [ModuleExport](interfaces/moduleexport.md)
 * [ModuleHandler](interfaces/modulehandler.md)
 * [Options](interfaces/options.md)
 * [PathHandlers](interfaces/pathhandlers.md)
@@ -18,13 +20,16 @@
 
 * [CustomBlockCallback](README.md#customblockcallback)
 * [File](README.md#file)
+* [LoadModule](README.md#loadmodule)
 
 ### Variables
 
 * [version](README.md#version)
+* [vueVersion](README.md#vueversion)
 
 ### Functions
 
+* [createSFCModule](README.md#createsfcmodule)
 * [loadModule](README.md#loadmodule)
 
 ### Object literals
@@ -35,9 +40,9 @@
 
 ### CustomBlockCallback
 
-Ƭ  **CustomBlockCallback**: (component: [Module](interfaces/module.md)) => undefined
+Ƭ  **CustomBlockCallback**: (component: [ModuleExport](interfaces/moduleexport.md)) => void
 
-*Defined in [index.ts:91](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L91)*
+*Defined in [types.ts:66](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L66)*
 
 CustomBlockCallback function type
 
@@ -47,27 +52,64 @@ ___
 
 Ƭ  **File**: string \| { content: string ; extname: string  }
 
-*Defined in [index.ts:85](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L85)*
+*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)*
+
 ## Variables
 
 ### version
 
 • `Const` **version**: string = process.env.VERSION
 
-*Defined in [index.ts:372](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L372)*
+*Defined in [tools.ts:39](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/tools.ts#L39)*
+
+*Defined in [index.ts:11](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/index.ts#L11)*
 
 the version of the library (process.env.VERSION is set by webpack, at compile-time)
 
+___
+
+### vueVersion
+
+• `Const` **vueVersion**: string
+
+*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/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)*
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`source` | string |
+`filename` | string |
+`options` | [Options](interfaces/options.md) |
+`loadModule` | [LoadModule](README.md#loadmodule) |
+
+**Returns:** Promise<[ModuleExport](interfaces/moduleexport.md)\>
+
+___
+
 ### loadModule
 
-▸ **loadModule**(`path`: string, `options_?`: [Options](interfaces/options.md)): Promise<[Module](interfaces/module.md)\>
+▸ **loadModule**(`path`: string, `options_?`: [Options](interfaces/options.md)): Promise<[ModuleExport](interfaces/moduleexport.md)\>
 
-*Defined in [index.ts:865](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L865)*
+*Defined in [index.ts:109](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/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.
@@ -80,7 +122,7 @@ 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. |
 `options_` | [Options](interfaces/options.md) | throwNotDefined('options') | - |
 
-**Returns:** Promise<[Module](interfaces/module.md)\>
+**Returns:** Promise<[ModuleExport](interfaces/moduleexport.md)\>
 
 A Promise of the component
 
@@ -121,7 +163,7 @@ A Promise of the component
 
 ▪ `Const` **defaultPathHandlers**: object
 
-*Defined in [index.ts:812](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L812)*
+*Defined in [index.ts:56](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/index.ts#L56)*
 
 Default implementation of PathHandlers
 

docs/api/interfaces/cache.md

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

docs/api/interfaces/customblock.md

@@ -0,0 +1,43 @@
+**[vue3-sfc-loader](../README.md)**
+
+> [Globals](../README.md) / CustomBlock
+
+# Interface: CustomBlock
+
+A custom block
+
+## Hierarchy
+
+* **CustomBlock**
+
+## Index
+
+### Properties
+
+* [attrs](customblock.md#attrs)
+* [content](customblock.md#content)
+* [type](customblock.md#type)
+
+## Properties
+
+### attrs
+
+•  **attrs**: Record<string, string \| true\>
+
+*Defined in [types.ts:75](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L75)*
+
+___
+
+### content
+
+•  **content**: string
+
+*Defined in [types.ts:74](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L74)*
+
+___
+
+### type
+
+•  **type**: string
+
+*Defined in [types.ts:73](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L73)*

docs/api/interfaces/module.md

@@ -9,3 +9,17 @@ This just represents a loaded js module
 ## Hierarchy
 
 * **Module**
+
+## Index
+
+### Properties
+
+* [exports](module.md#exports)
+
+## Properties
+
+### exports
+
+•  **exports**: [ModuleExport](moduleexport.md)
+
+*Defined in [types.ts:93](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L93)*

docs/api/interfaces/moduleexport.md

@@ -0,0 +1,11 @@
+**[vue3-sfc-loader](../README.md)**
+
+> [Globals](../README.md) / ModuleExport
+
+# Interface: ModuleExport
+
+This just represents a loaded js module exports
+
+## Hierarchy
+
+* **ModuleExport**

docs/api/interfaces/modulehandler.md

@@ -13,9 +13,9 @@ see [additionalModuleHandlers](options.md#additionalmodulehandlers)
 
 ## Callable
 
-▸ (`source`: string, `path`: string, `options`: [Options](options.md)): Promise<[Module](module.md)\>
+▸ (`source`: string, `path`: string, `options`: [Options](options.md)): Promise<[ModuleExport](moduleexport.md)\>
 
-*Defined in [index.ts:355](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L355)*
+*Defined in [types.ts:52](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/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)
@@ -28,4 +28,4 @@ Name | Type | Description |
 `path` | string | The path of the file |
 `options` | [Options](options.md) | The options   **example:**  ```javascript  ...  additionalModuleHandlers: {   '.json': (source, path, options) => JSON.parse(source),  }  ... ```  |
 
-**Returns:** Promise<[Module](module.md)\>
+**Returns:** Promise<[ModuleExport](moduleexport.md)\>

docs/api/interfaces/options.md

@@ -33,7 +33,7 @@
 
 • `Optional` **additionalBabelPlugins**: any[]
 
-*Defined in [index.ts:209](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L209)*
+*Defined in [types.ts:212](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L212)*
 
 Additional babel plugins. [TBD]
 
@@ -48,7 +48,7 @@ ___
 
 • `Optional` **additionalModuleHandlers**: Record<string, [ModuleHandler](modulehandler.md)\>
 
-*Defined in [index.ts:216](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L216)*
+*Defined in [types.ts:219](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L219)*
 
 Additional module type handlers. see [ModuleHandler](modulehandler.md)
 
@@ -58,7 +58,7 @@ ___
 
 • `Optional` **compiledCache**: [Cache](cache.md)
 
-*Defined in [index.ts:256](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L256)*
+*Defined in [types.ts:259](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L259)*
 
 [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.
@@ -100,9 +100,9 @@ ___
 
 ### delimiters
 
-• `Optional` **delimiters**: SFCTemplateCompileOptions[\"compilerOptions\"][\"delimiters\"]
+• `Optional` **delimiters**: [string, string]
 
-*Defined in [index.ts:198](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L198)*
+*Defined in [types.ts:201](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L201)*
 
 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 [index.ts:115](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L115)*
+*Defined in [types.ts:118](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L118)*
 
 Initial cache that will contain resolved dependencies. All new modules go here.
 `vue` must initially be contained in this object.
@@ -170,17 +170,17 @@ ___
 
 •  **pathHandlers**: [PathHandlers](pathhandlers.md)
 
-*Defined in [index.ts:302](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L302)*
+*Defined in [types.ts:305](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L305)*
 
 Abstact path handling
 
 ## Methods
 
 ### addStyle
 
-▸ **addStyle**(`style`: string, `scopeId`: string): void
+▸ **addStyle**(`style`: string, `scopeId`: string \| undefined): void
 
-*Defined in [index.ts:158](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L158)*
+*Defined in [types.ts:161](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L161)*
 
 Called by the library when CSS style must be added in the HTML document.
 
@@ -189,7 +189,7 @@ Called by the library when CSS style must be added in the HTML document.
 Name | Type | Description |
 ------ | ------ | ------ |
 `style` | string | The CSS style chunk |
-`scopeId` | string | The scope ID of the CSS style chunk |
+`scopeId` | string \| undefined | The scope ID of the CSS style chunk |
 
 **Returns:** void
 
@@ -210,17 +210,17 @@ ___
 
 ### customBlockHandler
 
-▸ **customBlockHandler**(`block`: SFCBlock, `filename`: string, `options`: [Options](options.md)): Promise<[CustomBlockCallback](../README.md#customblockcallback) \| undefined\>
+▸ `Optional`**customBlockHandler**(`block`: [CustomBlock](customblock.md), `filename`: string, `options`: [Options](options.md)): Promise<[CustomBlockCallback](../README.md#customblockcallback) \| undefined\>
 
-*Defined in [index.ts:324](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L324)*
+*Defined in [types.ts:327](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L327)*
 
 Called for each custom block.
 
 #### Parameters:
 
 Name | Type |
 ------ | ------ |
-`block` | SFCBlock |
+`block` | [CustomBlock](customblock.md) |
 `filename` | string |
 `options` | [Options](options.md) |
 
@@ -249,7 +249,7 @@ ___
 
 ▸ **getFile**(`path`: string): Promise<[File](../README.md#file)\>
 
-*Defined in [index.ts:136](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L136)*
+*Defined in [types.ts:139](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L139)*
 
 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 [index.ts:295](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L295)*
+*Defined in [types.ts:298](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L298)*
 
 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 [index.ts:274](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L274)*
+*Defined in [types.ts:277](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L277)*
 
 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 [index.ts:74](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L74)*
+*Defined in [types.ts:25](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L25)*
 
 #### Parameters:
 
@@ -37,7 +37,7 @@ ___
 
 ▸ **resolve**(`absoluteFilepath`: string, `dependencyPath`: string): string
 
-*Defined in [index.ts:78](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/6e3ae22/src/index.ts#L78)*
+*Defined in [types.ts:29](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/e87df0d/src/types.ts#L29)*
 
 #### Parameters: