@prismicio/vue 3.0.0 → 3.1.1
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/index.cjs +57 -19
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +128 -236
- package/dist/index.js +57 -19
- package/dist/index.js.map +1 -1
- package/package.json +27 -26
- package/src/components/PrismicEmbed.ts +2 -1
- package/src/components/PrismicImage.ts +6 -3
- package/src/components/PrismicLink.ts +4 -2
- package/src/components/PrismicRichText.ts +4 -2
- package/src/components/PrismicText.ts +6 -3
- package/src/components/SliceZone.ts +19 -8
- package/src/composables.ts +56 -46
- package/src/createPrismic.ts +5 -2
- package/src/injectionSymbols.ts +2 -1
- package/src/types.ts +14 -7
- package/src/useStatefulPrismicClientMethod.ts +6 -3
package/dist/index.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ declare type ExtractSliceType<TSlice extends SliceLike> = TSlice extends SliceLi
|
|
|
22
22
|
*/
|
|
23
23
|
declare type SliceLikeRestV2<TSliceType extends string = string> = {
|
|
24
24
|
slice_type: Slice<TSliceType>["slice_type"];
|
|
25
|
+
id?: string;
|
|
25
26
|
};
|
|
26
27
|
/**
|
|
27
28
|
* The minimum required properties to represent a Prismic Slice from the Prismic
|
|
@@ -43,7 +44,8 @@ declare type SliceLikeGraphQL<TSliceType extends string = string> = {
|
|
|
43
44
|
*/
|
|
44
45
|
declare type SliceLike<TSliceType extends string = string> = SliceLikeRestV2<TSliceType> | SliceLikeGraphQL<TSliceType>;
|
|
45
46
|
/**
|
|
46
|
-
* A looser version of the `SliceZone` type from `@prismicio/types` using
|
|
47
|
+
* A looser version of the `SliceZone` type from `@prismicio/types` using
|
|
48
|
+
* `SliceLike`.
|
|
47
49
|
*
|
|
48
50
|
* If using Prismic's REST API, use the `SliceZone` export from
|
|
49
51
|
* `@prismicio/types` for the full type.
|
|
@@ -73,7 +75,8 @@ declare type SliceComponentProps<TSlice extends SliceLike = any, TContext = unkn
|
|
|
73
75
|
*/
|
|
74
76
|
slices: SliceZoneLike<SliceLike>;
|
|
75
77
|
/**
|
|
76
|
-
* Arbitrary data passed to `<SliceZone />` and made available to all Slice
|
|
78
|
+
* Arbitrary data passed to `<SliceZone />` and made available to all Slice
|
|
79
|
+
* components.
|
|
77
80
|
*/
|
|
78
81
|
context: TContext;
|
|
79
82
|
};
|
|
@@ -81,7 +84,7 @@ declare type SliceComponentProps<TSlice extends SliceLike = any, TContext = unkn
|
|
|
81
84
|
* Native Vue props for a component rendering content from a Prismic Slice using
|
|
82
85
|
* the `<SliceZone />` component.
|
|
83
86
|
*
|
|
84
|
-
* @typeParam TSlice - The
|
|
87
|
+
* @typeParam TSlice - The Slice type
|
|
85
88
|
* @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
|
|
86
89
|
* available to all Slice components
|
|
87
90
|
*/
|
|
@@ -128,7 +131,7 @@ declare type DefineComponentSliceComponentProps<TSlice extends SliceLike = any,
|
|
|
128
131
|
* };
|
|
129
132
|
* ```
|
|
130
133
|
*
|
|
131
|
-
* @typeParam TSlice - The
|
|
134
|
+
* @typeParam TSlice - The Slice type
|
|
132
135
|
* @typeParam TContext - Arbitrary data passed to `<SliceZone />` and made
|
|
133
136
|
* available to all Slice components
|
|
134
137
|
* @param propsHint - An optional array of prop names used for the sole purpose
|
|
@@ -137,7 +140,7 @@ declare type DefineComponentSliceComponentProps<TSlice extends SliceLike = any,
|
|
|
137
140
|
*
|
|
138
141
|
* @returns Props object to use with {@link defineComponent}
|
|
139
142
|
*/
|
|
140
|
-
declare const getSliceComponentProps: <TSlice extends SliceLike<string> =
|
|
143
|
+
declare const getSliceComponentProps: <TSlice extends SliceLike<string> = any, TContext = unknown>(propsHint?: ["slice", "index", "slices", "context"]) => DefineComponentSliceComponentProps<TSlice, TContext>;
|
|
141
144
|
/**
|
|
142
145
|
* A Vue component to be rendered for each instance of its Slice.
|
|
143
146
|
*
|
|
@@ -146,7 +149,8 @@ declare const getSliceComponentProps: <TSlice extends SliceLike<string> = SliceL
|
|
|
146
149
|
*/
|
|
147
150
|
declare type SliceComponentType<TSlice extends SliceLike = any, TContext = unknown> = DefineComponent<SliceComponentProps<TSlice, TContext>> | FunctionalComponent<SliceComponentProps<TSlice, TContext>>;
|
|
148
151
|
/**
|
|
149
|
-
* This Slice component can be used as a reminder to provide a proper
|
|
152
|
+
* This Slice component can be used as a reminder to provide a proper
|
|
153
|
+
* implementation.
|
|
150
154
|
*
|
|
151
155
|
* This is also the default Vue component rendered when a component mapping
|
|
152
156
|
* cannot be found in `<SliceZone />`.
|
|
@@ -217,7 +221,8 @@ declare type SliceZoneResolverArgs<TSlice extends SliceLike = SliceLike> = {
|
|
|
217
221
|
/**
|
|
218
222
|
* A function that determines the rendered Vue component for each Slice in the
|
|
219
223
|
* Slice Zone. If a nullish value is returned, the component will fallback to
|
|
220
|
-
* the `components` or `defaultComponent` props to determine the rendered
|
|
224
|
+
* the `components` or `defaultComponent` props to determine the rendered
|
|
225
|
+
* component.
|
|
221
226
|
*
|
|
222
227
|
* @deprecated Use the `components` prop instead.
|
|
223
228
|
*
|
|
@@ -286,7 +291,8 @@ declare const SliceZone: new () => {
|
|
|
286
291
|
*/
|
|
287
292
|
declare type PrismicPluginComponentsOptions = {
|
|
288
293
|
/**
|
|
289
|
-
* Value of the `rel` attribute to use on links rendered with
|
|
294
|
+
* Value of the `rel` attribute to use on links rendered with
|
|
295
|
+
* `target="_blank"`
|
|
290
296
|
*
|
|
291
297
|
* @defaultValue `"noopener noreferrer"`
|
|
292
298
|
*/
|
|
@@ -318,7 +324,8 @@ declare type PrismicPluginComponentsOptions = {
|
|
|
318
324
|
*/
|
|
319
325
|
linkExternalComponent?: string | ConcreteComponent;
|
|
320
326
|
/**
|
|
321
|
-
* An HTML tag name, a component, or a functional component used to render
|
|
327
|
+
* An HTML tag name, a component, or a functional component used to render
|
|
328
|
+
* images.
|
|
322
329
|
*
|
|
323
330
|
* @remarks
|
|
324
331
|
* HTML tag names and components will be rendered using the `img` tag
|
|
@@ -361,13 +368,15 @@ declare type PrismicPluginComponentsOptions = {
|
|
|
361
368
|
declare type PrismicPluginOptionsBase = {
|
|
362
369
|
/**
|
|
363
370
|
* An optional link resolver function used to resolve links to Prismic
|
|
364
|
-
* documents when not using the route resolver parameter with
|
|
371
|
+
* documents when not using the route resolver parameter with
|
|
372
|
+
* `@prismicio/client`.
|
|
365
373
|
*
|
|
366
374
|
* @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
|
|
367
375
|
*/
|
|
368
376
|
linkResolver?: LinkResolverFunction;
|
|
369
377
|
/**
|
|
370
|
-
* An optional HTML serializer to customize the way rich text fields are
|
|
378
|
+
* An optional HTML serializer to customize the way rich text fields are
|
|
379
|
+
* rendered.
|
|
371
380
|
*
|
|
372
381
|
* @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
|
|
373
382
|
*/
|
|
@@ -490,7 +499,8 @@ declare type PrismicPluginOptionsWithEndpoint = PrismicPluginOptionsBase & {
|
|
|
490
499
|
declare type PrismicPluginOptions = PrismicPluginOptionsWithClient | PrismicPluginOptionsWithEndpoint;
|
|
491
500
|
/**
|
|
492
501
|
* `@prismicio/client` related methods and properties exposed by
|
|
493
|
-
* `@prismicio/vue` plugin and accessible through `this.$prismic` and
|
|
502
|
+
* `@prismicio/vue` plugin and accessible through `this.$prismic` and
|
|
503
|
+
* `usePrismic()`.
|
|
494
504
|
*/
|
|
495
505
|
declare type PrismicPluginClient = {
|
|
496
506
|
/**
|
|
@@ -548,7 +558,8 @@ declare type PrismicPluginHelpers = {
|
|
|
548
558
|
asDate: typeof asDate;
|
|
549
559
|
/**
|
|
550
560
|
* Returns the URL of an Image field with optional image transformations (via
|
|
551
|
-
* Imgix URL parameters). This is `@prismicio/helpers` {@link asImageSrc}
|
|
561
|
+
* Imgix URL parameters). This is `@prismicio/helpers` {@link asImageSrc}
|
|
562
|
+
* function.
|
|
552
563
|
*/
|
|
553
564
|
asImageSrc: typeof asImageSrc;
|
|
554
565
|
/**
|
|
@@ -611,7 +622,8 @@ declare const enum PrismicClientComposableState {
|
|
|
611
622
|
Error = "error"
|
|
612
623
|
}
|
|
613
624
|
/**
|
|
614
|
-
* Type to transform a static object into one that allows passing Refs as
|
|
625
|
+
* Type to transform a static object into one that allows passing Refs as
|
|
626
|
+
* values.
|
|
615
627
|
*
|
|
616
628
|
* @internal
|
|
617
629
|
*/
|
|
@@ -661,7 +673,8 @@ declare type PrismicEmbedProps = {
|
|
|
661
673
|
*/
|
|
662
674
|
field: EmbedField;
|
|
663
675
|
/**
|
|
664
|
-
* An HTML tag name, a component, or a functional component used to wrap the
|
|
676
|
+
* An HTML tag name, a component, or a functional component used to wrap the
|
|
677
|
+
* output.
|
|
665
678
|
*
|
|
666
679
|
* @defaultValue `"div"`
|
|
667
680
|
*/
|
|
@@ -686,7 +699,8 @@ declare type PrismicImageProps = {
|
|
|
686
699
|
*/
|
|
687
700
|
field: ImageField;
|
|
688
701
|
/**
|
|
689
|
-
* An HTML tag name, a component, or a functional component used to render
|
|
702
|
+
* An HTML tag name, a component, or a functional component used to render
|
|
703
|
+
* images.
|
|
690
704
|
*
|
|
691
705
|
* @remarks
|
|
692
706
|
* HTML tag names and components will be rendered using the `img` tag
|
|
@@ -716,7 +730,8 @@ declare type PrismicImageProps = {
|
|
|
716
730
|
*/
|
|
717
731
|
widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "thumbnails" | "defaults";
|
|
718
732
|
/**
|
|
719
|
-
* Adds an additional `srcset` attribute to the image following giving pixel
|
|
733
|
+
* Adds an additional `srcset` attribute to the image following giving pixel
|
|
734
|
+
* densities.
|
|
720
735
|
*
|
|
721
736
|
* @remarks
|
|
722
737
|
* A special value of `"defaults"` is accepted to automatically use image
|
|
@@ -753,7 +768,8 @@ declare type UsePrismicImageReturnType = {
|
|
|
753
768
|
copyright: ComputedRef<string | null>;
|
|
754
769
|
};
|
|
755
770
|
/**
|
|
756
|
-
* A low level composable that returns a resolved information about a Prismic
|
|
771
|
+
* A low level composable that returns a resolved information about a Prismic
|
|
772
|
+
* image field.
|
|
757
773
|
*
|
|
758
774
|
* @param props - {@link UsePrismicImageOptions}
|
|
759
775
|
*
|
|
@@ -796,7 +812,8 @@ declare type PrismicLinkProps = {
|
|
|
796
812
|
*/
|
|
797
813
|
rel?: string | null;
|
|
798
814
|
/**
|
|
799
|
-
* Value of the `rel` attribute to use on links rendered with
|
|
815
|
+
* Value of the `rel` attribute to use on links rendered with
|
|
816
|
+
* `target="_blank"`.
|
|
800
817
|
*
|
|
801
818
|
* @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"noopener noreferrer"` otherwise.
|
|
802
819
|
*/
|
|
@@ -854,7 +871,8 @@ declare type UsePrismicLinkReturnType = {
|
|
|
854
871
|
rel: ComputedRef<string | null>;
|
|
855
872
|
};
|
|
856
873
|
/**
|
|
857
|
-
* A low level composable that returns resolved information about a Prismic link
|
|
874
|
+
* A low level composable that returns resolved information about a Prismic link
|
|
875
|
+
* field.
|
|
858
876
|
*
|
|
859
877
|
* @param props - {@link UsePrismicLinkOptions}
|
|
860
878
|
*
|
|
@@ -886,7 +904,8 @@ declare type PrismicTextProps = {
|
|
|
886
904
|
*/
|
|
887
905
|
separator?: string;
|
|
888
906
|
/**
|
|
889
|
-
* An HTML tag name, a component, or a functional component used to wrap the
|
|
907
|
+
* An HTML tag name, a component, or a functional component used to wrap the
|
|
908
|
+
* output.
|
|
890
909
|
*
|
|
891
910
|
* @defaultValue `"div"`
|
|
892
911
|
*/
|
|
@@ -911,11 +930,13 @@ declare type UsePrismicTextReturnType = {
|
|
|
911
930
|
text: ComputedRef<string>;
|
|
912
931
|
};
|
|
913
932
|
/**
|
|
914
|
-
* A low level composable that returns a serialized rich text field as plain
|
|
933
|
+
* A low level composable that returns a serialized rich text field as plain
|
|
934
|
+
* text.
|
|
915
935
|
*
|
|
916
936
|
* @param props - {@link UsePrismicTextOptions}
|
|
917
937
|
*
|
|
918
|
-
* @returns - Serialized rich text field as plain text
|
|
938
|
+
* @returns - Serialized rich text field as plain text
|
|
939
|
+
* {@link UsePrismicTextReturnType}
|
|
919
940
|
*/
|
|
920
941
|
declare const usePrismicText: (props: UsePrismicTextOptions) => UsePrismicTextReturnType;
|
|
921
942
|
/**
|
|
@@ -954,7 +975,8 @@ declare type PrismicRichTextProps = {
|
|
|
954
975
|
*/
|
|
955
976
|
htmlSerializer?: HTMLFunctionSerializer | HTMLMapSerializer;
|
|
956
977
|
/**
|
|
957
|
-
* An HTML tag name, a component, or a functional component used to wrap the
|
|
978
|
+
* An HTML tag name, a component, or a functional component used to wrap the
|
|
979
|
+
* output.
|
|
958
980
|
*
|
|
959
981
|
* @defaultValue `"div"`
|
|
960
982
|
*/
|
|
@@ -983,7 +1005,8 @@ declare type UsePrismicRichTextReturnType = {
|
|
|
983
1005
|
*
|
|
984
1006
|
* @param props - {@link UsePrismicRichTextOptions}
|
|
985
1007
|
*
|
|
986
|
-
* @returns - Serialized rich text field as HTML
|
|
1008
|
+
* @returns - Serialized rich text field as HTML
|
|
1009
|
+
* {@link UsePrismicRichTextReturnType}
|
|
987
1010
|
*/
|
|
988
1011
|
declare const usePrismicRichText: (props: UsePrismicRichTextOptions) => UsePrismicRichTextReturnType;
|
|
989
1012
|
/**
|
|
@@ -1006,7 +1029,8 @@ declare type ComposableOnlyParameters = {
|
|
|
1006
1029
|
/**
|
|
1007
1030
|
* The return type of a `@prismicio/client` Vue composable.
|
|
1008
1031
|
*
|
|
1009
|
-
* @typeParam TData - The expected format of the `data` property of the returned
|
|
1032
|
+
* @typeParam TData - The expected format of the `data` property of the returned
|
|
1033
|
+
* object
|
|
1010
1034
|
*/
|
|
1011
1035
|
declare type ClientComposableReturnType<TData = unknown> = {
|
|
1012
1036
|
/**
|
|
@@ -1018,7 +1042,8 @@ declare type ClientComposableReturnType<TData = unknown> = {
|
|
|
1018
1042
|
*/
|
|
1019
1043
|
data: Ref<TData | null>;
|
|
1020
1044
|
/**
|
|
1021
|
-
* Error returned by the composable's client method call if in an errror
|
|
1045
|
+
* Error returned by the composable's client method call if in an errror
|
|
1046
|
+
* state.
|
|
1022
1047
|
*/
|
|
1023
1048
|
error: Ref<ClientError | Error | null>;
|
|
1024
1049
|
/**
|
|
@@ -1031,8 +1056,8 @@ declare type ClientComposableReturnType<TData = unknown> = {
|
|
|
1031
1056
|
* A composable that queries content from the Prismic repository.
|
|
1032
1057
|
*
|
|
1033
1058
|
* @remarks
|
|
1034
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1035
|
-
*
|
|
1059
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1060
|
+
* `params.client`.
|
|
1036
1061
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1037
1062
|
*
|
|
1038
1063
|
* @param params - Parameters to filter, sort, and paginate results
|
|
@@ -1042,23 +1067,15 @@ declare type ClientComposableReturnType<TData = unknown> = {
|
|
|
1042
1067
|
* @see Underlying `@prismicio/client` method {@link Client.get}
|
|
1043
1068
|
*/
|
|
1044
1069
|
declare const usePrismicDocuments: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1045
|
-
signal?:
|
|
1046
|
-
aborted: any;
|
|
1047
|
-
addEventListener: any;
|
|
1048
|
-
removeEventListener: any;
|
|
1049
|
-
dispatchEvent: any;
|
|
1050
|
-
onabort: any;
|
|
1051
|
-
reason: any;
|
|
1052
|
-
throwIfAborted: any;
|
|
1053
|
-
} | undefined;
|
|
1070
|
+
signal?: any;
|
|
1054
1071
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
|
|
1055
1072
|
/**
|
|
1056
1073
|
* A composable that queries content from the Prismic repository and returns
|
|
1057
1074
|
* only the first result, if any.
|
|
1058
1075
|
*
|
|
1059
1076
|
* @remarks
|
|
1060
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1061
|
-
*
|
|
1077
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1078
|
+
* `params.client`.
|
|
1062
1079
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
1063
1080
|
*
|
|
1064
1081
|
* @param params - Parameters to filter, sort, and paginate results
|
|
@@ -1068,22 +1085,15 @@ declare const usePrismicDocuments: <TDocument extends PrismicDocument<Record<str
|
|
|
1068
1085
|
* @see Underlying `@prismicio/client` method {@link Client.getFirst}
|
|
1069
1086
|
*/
|
|
1070
1087
|
declare const useFirstPrismicDocument: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1071
|
-
signal?:
|
|
1072
|
-
aborted: any;
|
|
1073
|
-
addEventListener: any;
|
|
1074
|
-
removeEventListener: any;
|
|
1075
|
-
dispatchEvent: any;
|
|
1076
|
-
onabort: any;
|
|
1077
|
-
reason: any;
|
|
1078
|
-
throwIfAborted: any;
|
|
1079
|
-
} | undefined;
|
|
1088
|
+
signal?: any;
|
|
1080
1089
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
|
|
1081
1090
|
/**
|
|
1082
|
-
* A composable that queries a document from the Prismic repository with a
|
|
1091
|
+
* A composable that queries a document from the Prismic repository with a
|
|
1092
|
+
* specific ID.
|
|
1083
1093
|
*
|
|
1084
1094
|
* @remarks
|
|
1085
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1086
|
-
*
|
|
1095
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1096
|
+
* `params.client`.
|
|
1087
1097
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
1088
1098
|
*
|
|
1089
1099
|
* @param id - ID of the document
|
|
@@ -1094,22 +1104,15 @@ declare const useFirstPrismicDocument: <TDocument extends PrismicDocument<Record
|
|
|
1094
1104
|
* @see Underlying `@prismicio/client` method {@link Client.getByID}
|
|
1095
1105
|
*/
|
|
1096
1106
|
declare const usePrismicDocumentByID: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(id: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1097
|
-
signal?:
|
|
1098
|
-
aborted: any;
|
|
1099
|
-
addEventListener: any;
|
|
1100
|
-
removeEventListener: any;
|
|
1101
|
-
dispatchEvent: any;
|
|
1102
|
-
onabort: any;
|
|
1103
|
-
reason: any;
|
|
1104
|
-
throwIfAborted: any;
|
|
1105
|
-
} | undefined;
|
|
1107
|
+
signal?: any;
|
|
1106
1108
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
|
|
1107
1109
|
/**
|
|
1108
|
-
* A composable that queries documents from the Prismic repository with specific
|
|
1110
|
+
* A composable that queries documents from the Prismic repository with specific
|
|
1111
|
+
* IDs.
|
|
1109
1112
|
*
|
|
1110
1113
|
* @remarks
|
|
1111
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1112
|
-
*
|
|
1114
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1115
|
+
* `params.client`.
|
|
1113
1116
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1114
1117
|
*
|
|
1115
1118
|
* @param ids - A list of document IDs
|
|
@@ -1120,22 +1123,15 @@ declare const usePrismicDocumentByID: <TDocument extends PrismicDocument<Record<
|
|
|
1120
1123
|
* @see Underlying `@prismicio/client` method {@link Client.getByIDs}
|
|
1121
1124
|
*/
|
|
1122
1125
|
declare const usePrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1123
|
-
signal?:
|
|
1124
|
-
aborted: any;
|
|
1125
|
-
addEventListener: any;
|
|
1126
|
-
removeEventListener: any;
|
|
1127
|
-
dispatchEvent: any;
|
|
1128
|
-
onabort: any;
|
|
1129
|
-
reason: any;
|
|
1130
|
-
throwIfAborted: any;
|
|
1131
|
-
} | undefined;
|
|
1126
|
+
signal?: any;
|
|
1132
1127
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
|
|
1133
1128
|
/**
|
|
1134
|
-
* A composable that queries all documents from the Prismic repository with
|
|
1129
|
+
* A composable that queries all documents from the Prismic repository with
|
|
1130
|
+
* specific IDs.
|
|
1135
1131
|
*
|
|
1136
1132
|
* @remarks
|
|
1137
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1138
|
-
*
|
|
1133
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1134
|
+
* `params.client`.
|
|
1139
1135
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1140
1136
|
*
|
|
1141
1137
|
* @param ids - A list of document IDs
|
|
@@ -1148,23 +1144,15 @@ declare const usePrismicDocumentsByIDs: <TDocument extends PrismicDocument<Recor
|
|
|
1148
1144
|
declare const useAllPrismicDocumentsByIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1149
1145
|
limit?: number | undefined;
|
|
1150
1146
|
} & {
|
|
1151
|
-
signal?:
|
|
1152
|
-
aborted: any;
|
|
1153
|
-
addEventListener: any;
|
|
1154
|
-
removeEventListener: any;
|
|
1155
|
-
dispatchEvent: any;
|
|
1156
|
-
onabort: any;
|
|
1157
|
-
reason: any;
|
|
1158
|
-
throwIfAborted: any;
|
|
1159
|
-
} | undefined;
|
|
1147
|
+
signal?: any;
|
|
1160
1148
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
|
|
1161
1149
|
/**
|
|
1162
1150
|
* A composable that queries a document from the Prismic repository with a
|
|
1163
1151
|
* specific UID and Custom Type.
|
|
1164
1152
|
*
|
|
1165
1153
|
* @remarks
|
|
1166
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1167
|
-
*
|
|
1154
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1155
|
+
* `params.client`.
|
|
1168
1156
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
1169
1157
|
*
|
|
1170
1158
|
* @param documentType - The API ID of the document's Custom Type
|
|
@@ -1176,22 +1164,15 @@ declare const useAllPrismicDocumentsByIDs: <TDocument extends PrismicDocument<Re
|
|
|
1176
1164
|
* @see Underlying `@prismicio/client` method {@link Client.getByUID}
|
|
1177
1165
|
*/
|
|
1178
1166
|
declare const usePrismicDocumentByUID: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, uid: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1179
|
-
signal?:
|
|
1180
|
-
aborted: any;
|
|
1181
|
-
addEventListener: any;
|
|
1182
|
-
removeEventListener: any;
|
|
1183
|
-
dispatchEvent: any;
|
|
1184
|
-
onabort: any;
|
|
1185
|
-
reason: any;
|
|
1186
|
-
throwIfAborted: any;
|
|
1187
|
-
} | undefined;
|
|
1167
|
+
signal?: any;
|
|
1188
1168
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
|
|
1189
1169
|
/**
|
|
1190
|
-
* A composable that queries documents from the Prismic repository with specific
|
|
1170
|
+
* A composable that queries documents from the Prismic repository with specific
|
|
1171
|
+
* UIDs.
|
|
1191
1172
|
*
|
|
1192
1173
|
* @remarks
|
|
1193
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1194
|
-
*
|
|
1174
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1175
|
+
* `params.client`.
|
|
1195
1176
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1196
1177
|
*
|
|
1197
1178
|
* @param documentType - The API ID of the document's Custom Type
|
|
@@ -1203,22 +1184,15 @@ declare const usePrismicDocumentByUID: <TDocument extends PrismicDocument<Record
|
|
|
1203
1184
|
* @see Underlying `@prismicio/client` method {@link Client.getByIDs}
|
|
1204
1185
|
*/
|
|
1205
1186
|
declare const usePrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1206
|
-
signal?:
|
|
1207
|
-
aborted: any;
|
|
1208
|
-
addEventListener: any;
|
|
1209
|
-
removeEventListener: any;
|
|
1210
|
-
dispatchEvent: any;
|
|
1211
|
-
onabort: any;
|
|
1212
|
-
reason: any;
|
|
1213
|
-
throwIfAborted: any;
|
|
1214
|
-
} | undefined;
|
|
1187
|
+
signal?: any;
|
|
1215
1188
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
|
|
1216
1189
|
/**
|
|
1217
|
-
* A composable that queries all documents from the Prismic repository with
|
|
1190
|
+
* A composable that queries all documents from the Prismic repository with
|
|
1191
|
+
* specific UIDs.
|
|
1218
1192
|
*
|
|
1219
1193
|
* @remarks
|
|
1220
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1221
|
-
*
|
|
1194
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1195
|
+
* `params.client`.
|
|
1222
1196
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1223
1197
|
*
|
|
1224
1198
|
* @param documentType - The API ID of the document's Custom Type
|
|
@@ -1232,23 +1206,15 @@ declare const usePrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Reco
|
|
|
1232
1206
|
declare const useAllPrismicDocumentsByUIDs: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, ids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1233
1207
|
limit?: number | undefined;
|
|
1234
1208
|
} & {
|
|
1235
|
-
signal?:
|
|
1236
|
-
aborted: any;
|
|
1237
|
-
addEventListener: any;
|
|
1238
|
-
removeEventListener: any;
|
|
1239
|
-
dispatchEvent: any;
|
|
1240
|
-
onabort: any;
|
|
1241
|
-
reason: any;
|
|
1242
|
-
throwIfAborted: any;
|
|
1243
|
-
} | undefined;
|
|
1209
|
+
signal?: any;
|
|
1244
1210
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
|
|
1245
1211
|
/**
|
|
1246
1212
|
* A composable that queries a singleton document from the Prismic repository
|
|
1247
1213
|
* for a specific Custom Type.
|
|
1248
1214
|
*
|
|
1249
1215
|
* @remarks
|
|
1250
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1251
|
-
*
|
|
1216
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1217
|
+
* `params.client`.
|
|
1252
1218
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
1253
1219
|
*
|
|
1254
1220
|
* @param documentType - The API ID of the singleton Custom Type
|
|
@@ -1259,23 +1225,15 @@ declare const useAllPrismicDocumentsByUIDs: <TDocument extends PrismicDocument<R
|
|
|
1259
1225
|
* @see Underlying `@prismicio/client` method {@link Client.getSingle}
|
|
1260
1226
|
*/
|
|
1261
1227
|
declare const useSinglePrismicDocument: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1262
|
-
signal?:
|
|
1263
|
-
aborted: any;
|
|
1264
|
-
addEventListener: any;
|
|
1265
|
-
removeEventListener: any;
|
|
1266
|
-
dispatchEvent: any;
|
|
1267
|
-
onabort: any;
|
|
1268
|
-
reason: any;
|
|
1269
|
-
throwIfAborted: any;
|
|
1270
|
-
} | undefined;
|
|
1228
|
+
signal?: any;
|
|
1271
1229
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument>;
|
|
1272
1230
|
/**
|
|
1273
1231
|
* A composable that queries documents from the Prismic repository for a
|
|
1274
1232
|
* specific Custom Type.
|
|
1275
1233
|
*
|
|
1276
1234
|
* @remarks
|
|
1277
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1278
|
-
*
|
|
1235
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1236
|
+
* `params.client`.
|
|
1279
1237
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1280
1238
|
*
|
|
1281
1239
|
* @param documentType - The API ID of the Custom Type
|
|
@@ -1286,23 +1244,15 @@ declare const useSinglePrismicDocument: <TDocument extends PrismicDocument<Recor
|
|
|
1286
1244
|
* @see Underlying `@prismicio/client` method {@link Client.getByType}
|
|
1287
1245
|
*/
|
|
1288
1246
|
declare const usePrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1289
|
-
signal?:
|
|
1290
|
-
aborted: any;
|
|
1291
|
-
addEventListener: any;
|
|
1292
|
-
removeEventListener: any;
|
|
1293
|
-
dispatchEvent: any;
|
|
1294
|
-
onabort: any;
|
|
1295
|
-
reason: any;
|
|
1296
|
-
throwIfAborted: any;
|
|
1297
|
-
} | undefined;
|
|
1247
|
+
signal?: any;
|
|
1298
1248
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
|
|
1299
1249
|
/**
|
|
1300
1250
|
* A composable that queries all documents from the Prismic repository for a
|
|
1301
1251
|
* specific Custom Type.
|
|
1302
1252
|
*
|
|
1303
1253
|
* @remarks
|
|
1304
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1305
|
-
*
|
|
1254
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1255
|
+
* `params.client`.
|
|
1306
1256
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1307
1257
|
*
|
|
1308
1258
|
* @param documentType - The API ID of the Custom Type
|
|
@@ -1315,22 +1265,15 @@ declare const usePrismicDocumentsByType: <TDocument extends PrismicDocument<Reco
|
|
|
1315
1265
|
declare const useAllPrismicDocumentsByType: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
|
|
1316
1266
|
limit?: number | undefined;
|
|
1317
1267
|
} & {
|
|
1318
|
-
signal?:
|
|
1319
|
-
aborted: any;
|
|
1320
|
-
addEventListener: any;
|
|
1321
|
-
removeEventListener: any;
|
|
1322
|
-
dispatchEvent: any;
|
|
1323
|
-
onabort: any;
|
|
1324
|
-
reason: any;
|
|
1325
|
-
throwIfAborted: any;
|
|
1326
|
-
} | undefined;
|
|
1268
|
+
signal?: any;
|
|
1327
1269
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
|
|
1328
1270
|
/**
|
|
1329
|
-
* A composable that queries documents from the Prismic repository with a
|
|
1271
|
+
* A composable that queries documents from the Prismic repository with a
|
|
1272
|
+
* specific tag.
|
|
1330
1273
|
*
|
|
1331
1274
|
* @remarks
|
|
1332
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1333
|
-
*
|
|
1275
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1276
|
+
* `params.client`.
|
|
1334
1277
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1335
1278
|
*
|
|
1336
1279
|
* @param tag - The tag that must be included on a document
|
|
@@ -1341,23 +1284,15 @@ declare const useAllPrismicDocumentsByType: <TDocument extends PrismicDocument<R
|
|
|
1341
1284
|
* @see Underlying `@prismicio/client` method {@link Client.getByTag}
|
|
1342
1285
|
*/
|
|
1343
1286
|
declare const usePrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1344
|
-
signal?:
|
|
1345
|
-
aborted: any;
|
|
1346
|
-
addEventListener: any;
|
|
1347
|
-
removeEventListener: any;
|
|
1348
|
-
dispatchEvent: any;
|
|
1349
|
-
onabort: any;
|
|
1350
|
-
reason: any;
|
|
1351
|
-
throwIfAborted: any;
|
|
1352
|
-
} | undefined;
|
|
1287
|
+
signal?: any;
|
|
1353
1288
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
|
|
1354
1289
|
/**
|
|
1355
1290
|
* A composable that queries all documents from the Prismic repository with a
|
|
1356
1291
|
* specific tag.
|
|
1357
1292
|
*
|
|
1358
1293
|
* @remarks
|
|
1359
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1360
|
-
*
|
|
1294
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1295
|
+
* `params.client`.
|
|
1361
1296
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1362
1297
|
*
|
|
1363
1298
|
* @param tag - The tag that must be included on a document
|
|
@@ -1370,23 +1305,15 @@ declare const usePrismicDocumentsByTag: <TDocument extends PrismicDocument<Recor
|
|
|
1370
1305
|
declare const useAllPrismicDocumentsByTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
|
|
1371
1306
|
limit?: number | undefined;
|
|
1372
1307
|
} & {
|
|
1373
|
-
signal?:
|
|
1374
|
-
aborted: any;
|
|
1375
|
-
addEventListener: any;
|
|
1376
|
-
removeEventListener: any;
|
|
1377
|
-
dispatchEvent: any;
|
|
1378
|
-
onabort: any;
|
|
1379
|
-
reason: any;
|
|
1380
|
-
throwIfAborted: any;
|
|
1381
|
-
} | undefined;
|
|
1308
|
+
signal?: any;
|
|
1382
1309
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
|
|
1383
1310
|
/**
|
|
1384
1311
|
* A composable that queries documents from the Prismic repository with specific
|
|
1385
1312
|
* tags. A document must be tagged with all of the queried tags to be included.
|
|
1386
1313
|
*
|
|
1387
1314
|
* @remarks
|
|
1388
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1389
|
-
*
|
|
1315
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1316
|
+
* `params.client`.
|
|
1390
1317
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1391
1318
|
*
|
|
1392
1319
|
* @param tags - A list of tags that must be included on a document
|
|
@@ -1397,23 +1324,16 @@ declare const useAllPrismicDocumentsByTag: <TDocument extends PrismicDocument<Re
|
|
|
1397
1324
|
* @see Underlying `@prismicio/client` method {@link Client.getByTags}
|
|
1398
1325
|
*/
|
|
1399
1326
|
declare const usePrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1400
|
-
signal?:
|
|
1401
|
-
aborted: any;
|
|
1402
|
-
addEventListener: any;
|
|
1403
|
-
removeEventListener: any;
|
|
1404
|
-
dispatchEvent: any;
|
|
1405
|
-
onabort: any;
|
|
1406
|
-
reason: any;
|
|
1407
|
-
throwIfAborted: any;
|
|
1408
|
-
} | undefined;
|
|
1327
|
+
signal?: any;
|
|
1409
1328
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
|
|
1410
1329
|
/**
|
|
1411
1330
|
* A composable that queries all documents from the Prismic repository with
|
|
1412
|
-
* specific tags. A document must be tagged with all of the queried tags to be
|
|
1331
|
+
* specific tags. A document must be tagged with all of the queried tags to be
|
|
1332
|
+
* included.
|
|
1413
1333
|
*
|
|
1414
1334
|
* @remarks
|
|
1415
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1416
|
-
*
|
|
1335
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1336
|
+
* `params.client`.
|
|
1417
1337
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1418
1338
|
*
|
|
1419
1339
|
* @param tags - A list of tags that must be included on a document
|
|
@@ -1426,23 +1346,16 @@ declare const usePrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<
|
|
|
1426
1346
|
declare const useAllPrismicDocumentsByEveryTag: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
|
|
1427
1347
|
limit?: number | undefined;
|
|
1428
1348
|
} & {
|
|
1429
|
-
signal?:
|
|
1430
|
-
aborted: any;
|
|
1431
|
-
addEventListener: any;
|
|
1432
|
-
removeEventListener: any;
|
|
1433
|
-
dispatchEvent: any;
|
|
1434
|
-
onabort: any;
|
|
1435
|
-
reason: any;
|
|
1436
|
-
throwIfAborted: any;
|
|
1437
|
-
} | undefined;
|
|
1349
|
+
signal?: any;
|
|
1438
1350
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
|
|
1439
1351
|
/**
|
|
1440
1352
|
* A composable that queries documents from the Prismic repository with specific
|
|
1441
|
-
* tags. A document must be tagged with at least one of the queried tags to be
|
|
1353
|
+
* tags. A document must be tagged with at least one of the queried tags to be
|
|
1354
|
+
* included.
|
|
1442
1355
|
*
|
|
1443
1356
|
* @remarks
|
|
1444
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1445
|
-
*
|
|
1357
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1358
|
+
* `params.client`.
|
|
1446
1359
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1447
1360
|
*
|
|
1448
1361
|
* @param tags - A list of tags that must be included on a document
|
|
@@ -1453,15 +1366,7 @@ declare const useAllPrismicDocumentsByEveryTag: <TDocument extends PrismicDocume
|
|
|
1453
1366
|
* @see Underlying `@prismicio/client` method {@link Client.getByTags}
|
|
1454
1367
|
*/
|
|
1455
1368
|
declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & {
|
|
1456
|
-
signal?:
|
|
1457
|
-
aborted: any;
|
|
1458
|
-
addEventListener: any;
|
|
1459
|
-
removeEventListener: any;
|
|
1460
|
-
dispatchEvent: any;
|
|
1461
|
-
onabort: any;
|
|
1462
|
-
reason: any;
|
|
1463
|
-
throwIfAborted: any;
|
|
1464
|
-
} | undefined;
|
|
1369
|
+
signal?: any;
|
|
1465
1370
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<Query<TDocument>>;
|
|
1466
1371
|
/**
|
|
1467
1372
|
* A composable that queries all documents from the Prismic repository with
|
|
@@ -1469,8 +1374,8 @@ declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<
|
|
|
1469
1374
|
* tags to be included.
|
|
1470
1375
|
*
|
|
1471
1376
|
* @remarks
|
|
1472
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1473
|
-
*
|
|
1377
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1378
|
+
* `params.client`.
|
|
1474
1379
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1475
1380
|
*
|
|
1476
1381
|
* @param tags - A list of tags that must be included on a document
|
|
@@ -1483,27 +1388,21 @@ declare const usePrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<
|
|
|
1483
1388
|
declare const useAllPrismicDocumentsBySomeTags: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(tags: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
|
|
1484
1389
|
limit?: number | undefined;
|
|
1485
1390
|
} & {
|
|
1486
|
-
signal?:
|
|
1487
|
-
aborted: any;
|
|
1488
|
-
addEventListener: any;
|
|
1489
|
-
removeEventListener: any;
|
|
1490
|
-
dispatchEvent: any;
|
|
1491
|
-
onabort: any;
|
|
1492
|
-
reason: any;
|
|
1493
|
-
throwIfAborted: any;
|
|
1494
|
-
} | undefined;
|
|
1391
|
+
signal?: any;
|
|
1495
1392
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
|
|
1496
1393
|
/**
|
|
1497
1394
|
* **IMPORTANT**: Avoid using `dangerouslyUseAllPrismicDocuments` as it may be
|
|
1498
1395
|
* slower and require more resources than other composables. Prefer using other
|
|
1499
|
-
* composables that filter by predicates such as
|
|
1396
|
+
* composables that filter by predicates such as
|
|
1397
|
+
* `useAllPrismicDocumentsByType`.
|
|
1500
1398
|
*
|
|
1501
1399
|
* A composable that queries content from the Prismic repository and returns all
|
|
1502
|
-
* matching content. If no predicates are provided, all documents will be
|
|
1400
|
+
* matching content. If no predicates are provided, all documents will be
|
|
1401
|
+
* fetched.
|
|
1503
1402
|
*
|
|
1504
1403
|
* @remarks
|
|
1505
|
-
* An additional `@prismicio/client` instance can be provided at
|
|
1506
|
-
*
|
|
1404
|
+
* An additional `@prismicio/client` instance can be provided at
|
|
1405
|
+
* `params.client`.
|
|
1507
1406
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
1508
1407
|
*
|
|
1509
1408
|
* @param params - Parameters to filter and sort results
|
|
@@ -1515,19 +1414,12 @@ declare const useAllPrismicDocumentsBySomeTags: <TDocument extends PrismicDocume
|
|
|
1515
1414
|
declare const dangerouslyUseAllPrismicDocuments: <TDocument extends PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
|
|
1516
1415
|
limit?: number | undefined;
|
|
1517
1416
|
} & {
|
|
1518
|
-
signal?:
|
|
1519
|
-
aborted: any;
|
|
1520
|
-
addEventListener: any;
|
|
1521
|
-
removeEventListener: any;
|
|
1522
|
-
dispatchEvent: any;
|
|
1523
|
-
onabort: any;
|
|
1524
|
-
reason: any;
|
|
1525
|
-
throwIfAborted: any;
|
|
1526
|
-
} | undefined;
|
|
1417
|
+
signal?: any;
|
|
1527
1418
|
} & ComposableOnlyParameters) | undefined) => ClientComposableReturnType<TDocument[]>;
|
|
1528
1419
|
|
|
1529
1420
|
/**
|
|
1530
|
-
* `@prismicio/vue` plugin interface interface location used for
|
|
1421
|
+
* `@prismicio/vue` plugin interface interface location used for
|
|
1422
|
+
* {@link usePrismic}.
|
|
1531
1423
|
*
|
|
1532
1424
|
* @internal
|
|
1533
1425
|
*/
|