Skip to content

Commit a5df5a3

Browse files
chore(docs) build docs v%npm_package_version%
1 parent b2f09c7 commit a5df5a3

File tree

5 files changed

+51
-26
lines changed

5 files changed

+51
-26
lines changed

docs/api/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
Ƭ **File**: string \| { content: string ; extname: string }
3333

34-
*Defined in [index.ts:75](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L75)*
34+
*Defined in [index.ts:75](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L75)*
3535

3636
Represents the content of the file or the content and the extension name.
3737

@@ -41,7 +41,7 @@ Represents the content of the file or the content and the extension name.
4141

4242
`Const` **version**: string = process.env.VERSION
4343

44-
*Defined in [index.ts:278](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L278)*
44+
*Defined in [index.ts:278](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L278)*
4545

4646
the version of the library (process.env.VERSION is set by webpack, at compile-time)
4747

@@ -51,7 +51,7 @@ the version of the library (process.env.VERSION is set by webpack, at compile-ti
5151

5252
**loadModule**(`path`: string, `options?`: [Options](interfaces/options.md)): Promise\<[Module](interfaces/module.md)>
5353

54-
*Defined in [index.ts:744](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L744)*
54+
*Defined in [index.ts:749](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L749)*
5555

5656
This is the main function.
5757

docs/api/interfaces/cache.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
**get**(`key`: string): Promise\<string>
2323

24-
*Defined in [index.ts:67](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L67)*
24+
*Defined in [index.ts:67](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L67)*
2525

2626
#### Parameters:
2727

@@ -37,7 +37,7 @@ ___
3737

3838
**set**(`key`: string, `value`: string): Promise\<void>
3939

40-
*Defined in [index.ts:68](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L68)*
40+
*Defined in [index.ts:68](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L68)*
4141

4242
#### Parameters:
4343

docs/api/interfaces/modulehandler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ see [additionalModuleHandlers](options.md#additionalmodulehandlers)
1515

1616
▸ (`source`: string, `path`: string, `options`: [Options](options.md)): Promise\<[Module](module.md)>
1717

18-
*Defined in [index.ts:261](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L261)*
18+
*Defined in [index.ts:261](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L261)*
1919

2020
Used by the library when it does not know how to handle a given file type (eg. `.json` files).
2121
see [additionalModuleHandlers](options.md#additionalmodulehandlers)

docs/api/interfaces/options.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
`Optional` **additionalBabelPlugins**: any[]
3232

33-
*Defined in [index.ts:146](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L146)*
33+
*Defined in [index.ts:146](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L146)*
3434

3535
Additional babel plugins. [TBD]
3636

@@ -45,7 +45,7 @@ ___
4545

4646
`Optional` **additionalModuleHandlers**: Record\<string, [ModuleHandler](modulehandler.md)>
4747

48-
*Defined in [index.ts:153](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L153)*
48+
*Defined in [index.ts:153](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L153)*
4949

5050
Additional module type handlers. see [ModuleHandler](modulehandler.md)
5151

@@ -55,7 +55,7 @@ ___
5555

5656
`Optional` **compiledCache**: [Cache](cache.md)
5757

58-
*Defined in [index.ts:193](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L193)*
58+
*Defined in [index.ts:193](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L193)*
5959

6060
[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`).
6161
Since compilation consume a lot of CPU, is is always a good idea to provide this object.
@@ -99,9 +99,9 @@ ___
9999

100100
`Optional` **moduleCache**: Record\<string, [Module](module.md)>
101101

102-
*Defined in [index.ts:95](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L95)*
102+
*Defined in [index.ts:95](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L95)*
103103

104-
Initial cache that will contain resolved dependencies.
104+
Initial cache that will contain resolved dependencies. All new modules go here.
105105
`vue` must initially be contained in this object.
106106

107107
**example:**
@@ -119,7 +119,7 @@ Initial cache that will contain resolved dependencies.
119119

120120
**addStyle**(`style`: string, `scopeId`: string): void
121121

122-
*Defined in [index.ts:135](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L135)*
122+
*Defined in [index.ts:135](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L135)*
123123

124124
Called by the library when CSS style must be added in the HTML document.
125125

@@ -151,7 +151,7 @@ ___
151151

152152
**getFile**(`path`: string): Promise\<[File](../README.md#file)>
153153

154-
*Defined in [index.ts:113](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L113)*
154+
*Defined in [index.ts:113](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L113)*
155155

156156
Called by the library when it needs a file.
157157

@@ -181,7 +181,7 @@ ___
181181

182182
`Optional`**loadModule**(`path`: string, `options`: [Options](options.md)): Promise\<[Module](module.md)> \| undefined
183183

184-
*Defined in [index.ts:230](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L230)*
184+
*Defined in [index.ts:230](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L230)*
185185

186186
Called when the lib requires a module. Do return `undefined` to let the library handle this.
187187

@@ -212,7 +212,7 @@ ___
212212

213213
`Optional`**log**(`type`: string, ...`data`: any[]): void
214214

215-
*Defined in [index.ts:211](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/df65a78/src/index.ts#L211)*
215+
*Defined in [index.ts:211](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/b2f09c7/src/index.ts#L211)*
216216

217217
Called by the library when there is somthing to log (eg. scripts compilation errors, template compilation errors, template compilation tips, style compilation errors, ...)
218218

0 commit comments

Comments
 (0)