@trackunit/react-core-contexts-test 0.1.76 → 0.1.78

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -28,6 +28,8 @@ export declare class TrackunitProvidersMockBuilder {
      * Use this Analytics Context.
      * Defaults to mockAnalyticsContext.
      *
+     * This context is used by the useAnalytics hook from lib "@trackunit/react-core-hooks"
+     *
      * @see mockAnalyticsContext
      * @example
      * ...
@@ -51,6 +53,8 @@ export declare class TrackunitProvidersMockBuilder {
      * Use this Environment Context.
      * Defaults to mockEnvironmentContext.
      *
+     * This context is used by the useEnvironment hook from lib "@trackunit/react-core-hooks"
+     *
      * @see mockEnvironmentContext
      * @example
      * ...
@@ -74,6 +78,8 @@ export declare class TrackunitProvidersMockBuilder {
      * Use this to pass in a differerent current user.
      * Defaults to mockCurrentUserContext.
      *
+     * This context is used by the useCurrentUser hook from lib "@trackunit/react-core-hooks"
+     *
      * @see mockCurrentUserContext
      * @example
      * ...
@@ -96,6 +102,8 @@ export declare class TrackunitProvidersMockBuilder {
      * Use this to pass in a differerent current user subscription.
      * Defaults to mockUserSubscriptionContext.
      *
+     * This context is used by the useUserSubscription hook from lib "@trackunit/react-core-hooks"
+     *
      * @see mockUserSubscriptionContext
      * @example
      * ...
@@ -120,6 +128,8 @@ export declare class TrackunitProvidersMockBuilder {
      * Set global asset sorting context.
      * Defaults to mockAssetSortingContext.
      *
+     * This context is used by the useAssetSorting hook from lib "@trackunit/react-core-hooks"
+     *
      * @see mockAssetSortingContext
      * @example
      * ...
@@ -143,6 +153,8 @@ export declare class TrackunitProvidersMockBuilder {
      * Set OEM Branding context.
      * Defaults to mockOemBrandingContext.
      *
+     * This context is used by the useAssetSorting hook from lib "@trackunit/react-core-hooks"
+     *
      * @see mockOemBrandingContext
      * @example
      * ...
@@ -165,6 +177,8 @@ export declare class TrackunitProvidersMockBuilder {
      * Use this ToastContext with the given mocks.
      * Defaults to mockToastContext.
      *
+     * This context is used by the useToast hook from lib "@trackunit/react-core-hooks"
+     *
      * @see mockToastContext
      * @example
      * ...
@@ -187,6 +201,8 @@ export declare class TrackunitProvidersMockBuilder {
      * Use this global selection.
      * Defaults to null.
      *
+     * This context is used by the useGlobalSelection hook from lib "@trackunit/react-core-hooks"
+     *
      * @example
      * ...
      * it("should allow render", async () => {
@@ -208,6 +224,8 @@ export declare class TrackunitProvidersMockBuilder {
     /**
      * Use this token.
      *
+     * This context is used by the useToken hook from lib "@trackunit/react-core-hooks"
+     *
      * @example
      * ...
      * it("should allow render", async () => {
@@ -229,6 +247,8 @@ export declare class TrackunitProvidersMockBuilder {
     /**
      * Use this Router Props with the given mocks.
      *
+     * This is used to provide a MemoryRouter from lib "react-router-dom"
+     *
      * @example
      * ...
      * it("should allow render", async () => {
@@ -250,6 +270,8 @@ export declare class TrackunitProvidersMockBuilder {
     /**
      * Use this Manager Apollo Context Provider with the given mocks.
      *
+     * This context is used by the useQuery and useLazyQuery hook from lib "@apollo/client"
+     *
      * @see https://www.apollographql.com/docs/react/development-testing/testing
      * @example
      * ...