Skip to content

Commit b67e3a5

Browse files
Merge pull request #21 from zeixcom/docs
fix: convert URLs to relative paths
2 parents 08336bd + b9279ae commit b67e3a5

File tree

177 files changed

+268
-224
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+268
-224
lines changed

docs-src/api/classes/ContextRequestEvent.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: ContextRequestEvent\<T\>
22

3-
Defined in: [src/context.ts:78](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/context.ts#L78)
3+
Defined in: [src/context.ts:78](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/context.ts#L78)
44

55
Class for context-request events
66

@@ -31,7 +31,7 @@ function to the callback which requesters can invoke to indicate they no longer
3131

3232
> **new ContextRequestEvent**\<`T`\>(`context`, `callback`, `subscribe?`): `ContextRequestEvent`\<`T`\>
3333
34-
Defined in: [src/context.ts:83](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/context.ts#L83)
34+
Defined in: [src/context.ts:83](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/context.ts#L83)
3535

3636
###### Parameters
3737

@@ -101,7 +101,7 @@ Defined in: node\_modules/typescript/lib/lib.dom.d.ts:11463
101101

102102
> `readonly` **callback**: [`ContextCallback`](../type-aliases/ContextCallback.md)\<[`ContextType`](../type-aliases/ContextType.md)\<`T`\>\>
103103
104-
Defined in: [src/context.ts:80](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/context.ts#L80)
104+
Defined in: [src/context.ts:80](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/context.ts#L80)
105105

106106
callback function for value getter and unsubscribe function
107107

@@ -173,7 +173,7 @@ The read-only **`composed`** property of the or not the event will propagate acr
173173

174174
> `readonly` **context**: `T`
175175
176-
Defined in: [src/context.ts:79](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/context.ts#L79)
176+
Defined in: [src/context.ts:79](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/context.ts#L79)
177177

178178
context key
179179

@@ -295,7 +295,7 @@ The deprecated **`Event.srcElement`** is an alias for the Event.target property.
295295

296296
> `readonly` **subscribe**: `boolean`
297297
298-
Defined in: [src/context.ts:81](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/context.ts#L81)
298+
Defined in: [src/context.ts:81](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/context.ts#L81)
299299

300300
whether to subscribe to context changes
301301

docs-src/api/classes/DependencyTimeoutError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: DependencyTimeoutError
22

3-
Defined in: [src/errors.ts:104](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L104)
3+
Defined in: [src/errors.ts:104](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L104)
44

55
Error when a component's dependencies are not met within a specified timeout
66

@@ -18,7 +18,7 @@ Error when a component's dependencies are not met within a specified timeout
1818

1919
> **new DependencyTimeoutError**(`host`, `missing`): `DependencyTimeoutError`
2020
21-
Defined in: [src/errors.ts:109](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L109)
21+
Defined in: [src/errors.ts:109](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L109)
2222

2323
###### Parameters
2424

docs-src/api/classes/InvalidComponentNameError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: InvalidComponentNameError
22

3-
Defined in: [src/errors.ts:11](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L11)
3+
Defined in: [src/errors.ts:11](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L11)
44

55
Error thrown when component name violates rules for custom element names
66

@@ -18,7 +18,7 @@ Error thrown when component name violates rules for custom element names
1818

1919
> **new InvalidComponentNameError**(`component`): `InvalidComponentNameError`
2020
21-
Defined in: [src/errors.ts:15](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L15)
21+
Defined in: [src/errors.ts:15](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L15)
2222

2323
###### Parameters
2424

docs-src/api/classes/InvalidCustomElementError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: InvalidCustomElementError
22

3-
Defined in: [src/errors.ts:141](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L141)
3+
Defined in: [src/errors.ts:141](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L141)
44

55
Error thrown when target element is not a custom element as expected
66

@@ -18,7 +18,7 @@ Error thrown when target element is not a custom element as expected
1818

1919
> **new InvalidCustomElementError**(`target`, `where`): `InvalidCustomElementError`
2020
21-
Defined in: [src/errors.ts:146](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L146)
21+
Defined in: [src/errors.ts:146](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L146)
2222

2323
###### Parameters
2424

docs-src/api/classes/InvalidEffectsError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: InvalidEffectsError
22

3-
Defined in: [src/errors.ts:47](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L47)
3+
Defined in: [src/errors.ts:47](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L47)
44

55
Error thrown when setup function does not return effects
66

@@ -18,7 +18,7 @@ Error thrown when setup function does not return effects
1818

1919
> **new InvalidEffectsError**(`host`, `cause?`): `InvalidEffectsError`
2020
21-
Defined in: [src/errors.ts:52](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L52)
21+
Defined in: [src/errors.ts:52](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L52)
2222

2323
###### Parameters
2424

docs-src/api/classes/InvalidPropertyNameError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: InvalidPropertyNameError
22

3-
Defined in: [src/errors.ts:28](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L28)
3+
Defined in: [src/errors.ts:28](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L28)
44

55
Error thrown when trying to assign a property name that conflicts with reserved words or inherited HTMLElement properties
66

@@ -18,7 +18,7 @@ Error thrown when trying to assign a property name that conflicts with reserved
1818

1919
> **new InvalidPropertyNameError**(`component`, `prop`, `reason`): `InvalidPropertyNameError`
2020
21-
Defined in: [src/errors.ts:34](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L34)
21+
Defined in: [src/errors.ts:34](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L34)
2222

2323
###### Parameters
2424

docs-src/api/classes/InvalidReactivesError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: InvalidReactivesError
22

3-
Defined in: [src/errors.ts:122](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L122)
3+
Defined in: [src/errors.ts:122](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L122)
44

55
Error thrown when reactives passed to a component are invalid
66

@@ -18,7 +18,7 @@ Error thrown when reactives passed to a component are invalid
1818

1919
> **new InvalidReactivesError**(`host`, `target`, `reactives`): `InvalidReactivesError`
2020
21-
Defined in: [src/errors.ts:128](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L128)
21+
Defined in: [src/errors.ts:128](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L128)
2222

2323
###### Parameters
2424

docs-src/api/classes/InvalidUIKeyError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: InvalidUIKeyError
22

3-
Defined in: [src/errors.ts:66](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L66)
3+
Defined in: [src/errors.ts:66](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L66)
44

55
Error thrown if UI key is invalid
66

@@ -18,7 +18,7 @@ Error thrown if UI key is invalid
1818

1919
> **new InvalidUIKeyError**(`host`, `key`, `where`): `InvalidUIKeyError`
2020
21-
Defined in: [src/errors.ts:72](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L72)
21+
Defined in: [src/errors.ts:72](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L72)
2222

2323
###### Parameters
2424

docs-src/api/classes/MissingElementError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Class: MissingElementError
22

3-
Defined in: [src/errors.ts:85](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L85)
3+
Defined in: [src/errors.ts:85](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L85)
44

55
Error thrown when a required descendant element does not exist in a component's DOM subtree
66

@@ -18,7 +18,7 @@ Error thrown when a required descendant element does not exist in a component's
1818

1919
> **new MissingElementError**(`host`, `selector`, `required`): `MissingElementError`
2020
21-
Defined in: [src/errors.ts:91](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/errors.ts#L91)
21+
Defined in: [src/errors.ts:91](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/errors.ts#L91)
2222

2323
###### Parameters
2424

docs-src/api/functions/asBoolean.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> **asBoolean**(): [`Parser`](../type-aliases/Parser.md)\<`boolean`, [`UI`](../type-aliases/UI.md)\>
44
5-
Defined in: [src/parsers/boolean.ts:14](https://github.com/zeixcom/le-truc/blob/3c6c7508028647082cdb37ad7cc35a4e25e83a85/src/parsers/boolean.ts#L14)
5+
Defined in: [src/parsers/boolean.ts:14](https://github.com/zeixcom/le-truc/blob/d8168684fc4cb8d811d0fffec6f48f3c78b3f3fb/src/parsers/boolean.ts#L14)
66

77
Parser that converts a boolean HTML attribute to an actual boolean.
88

0 commit comments

Comments
 (0)