@vendure/docs 0.0.0-202603201037 → 0.0.0-202603260613
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dates.generated.js +821 -821
- package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
- package/package.json +1 -1
- package/src/dates.generated.ts +821 -821
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: "CustomFieldConfig"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="
|
|
5
|
+
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="254" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
An object used to configure a custom field.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: "CustomFields"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="
|
|
5
|
+
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="290" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
Most entities can have additional fields added to them by defining an array of [CustomFieldConfig](/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig)objects on against the corresponding key.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: "StructCustomFieldConfig"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="
|
|
5
|
+
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="241" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
7
|
Configures a "struct" custom field.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: "StructFieldConfig"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="
|
|
5
|
+
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="226" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
7
|
Configures an individual field of a "struct" custom field. The individual fields share
|
|
8
8
|
the same API as the top-level custom fields, with the exception that they do not support the
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: "TypedCustomSingleFieldConfig"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="
|
|
5
|
+
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="101" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
Configures a custom field on an entity in the [CustomFields](/reference/typescript-api/custom-fields/#customfields) config object.
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ Events are published whenever certain actions take place within the Vendure serv
|
|
|
12
12
|
* when an Order transitions state ([OrderStateTransitionEvent](/reference/typescript-api/events/event-types#orderstatetransitionevent))
|
|
13
13
|
* when a Customer registers a new account ([AccountRegistrationEvent](/reference/typescript-api/events/event-types#accountregistrationevent))
|
|
14
14
|
|
|
15
|
-
Using the EventBus it is possible to subscribe to
|
|
15
|
+
Using the EventBus it is possible to subscribe to and take action when these events occur.
|
|
16
16
|
This is done with the `.ofType()` method, which takes an event type and returns an rxjs observable
|
|
17
17
|
stream of events:
|
|
18
18
|
|