feat: add UserParams type in export

gravity-ui · Nov 14, 2023 · 284ad8f · 284ad8f
1 parent add45c1
commit 284ad8f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -346,6 +346,10 @@ app.get((req, res) => {
 Plugin options:
 
 ```typescript
+export type UserParams = {
+  [x: string]: boolean | string | number | null | UserParams;
+};
+
 export interface MetrikaCounter {
   id: number;
   defer: boolean;
@@ -359,9 +363,7 @@ export interface MetrikaCounter {
   trackHash?: boolean;
   ecommerce?: boolean | string;
   type?: number;
-  userParams?: {
-    [x: string]: boolean | string | number;
-  };
+  userParams?: UserParams;
 }
 
 export type MetrikaOptions = {

diff --git a/src/index.ts b/src/index.ts
@@ -18,7 +18,11 @@ export type {
     RenderParams,
 } from './types.js';
 
-export type {MetrikaCounter, MetrikaPluginOptions} from './plugins/yandex-metrika/index.js';
+export type {
+    MetrikaCounter,
+    MetrikaPluginOptions,
+    UserParams,
+} from './plugins/yandex-metrika/index.js';
 export type {
     GoogleAnalyticsCounter,
     GoogleAnalyticsPluginOptions,

diff --git a/src/plugins/yandex-metrika/index.ts b/src/plugins/yandex-metrika/index.ts
@@ -1,7 +1,7 @@
 import type {Plugin, RenderHelpers} from '../../types.js';
 import type {MetrikaCounter, MetrikaPluginOptions} from './types.js';
 
-export type {MetrikaCounter, MetrikaPluginOptions} from './types.js';
+export type {MetrikaCounter, MetrikaPluginOptions, UserParams} from './types.js';
 
 export function createYandexMetrikaPlugin(): Plugin<MetrikaPluginOptions, 'yandexMetrika'> {
     return {

diff --git a/src/plugins/yandex-metrika/types.ts b/src/plugins/yandex-metrika/types.ts
@@ -1,4 +1,4 @@
-type UserParams = {
+export type UserParams = {
     [x: string]: boolean | string | number | null | UserParams;
 };