2.0.3 • Published 6 months ago

@types/react-gtm-module v2.0.3

Weekly downloads
53,282
License
MIT
Repository
github
Last release
6 months ago

Installation

npm install --save @types/react-gtm-module

Summary

This package contains type definitions for react-gtm-module (https://github.com/alinemorelli/react-gtm).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-gtm-module.

index.d.ts

// Type definitions for react-gtm-module 2.0
// Project: https://github.com/alinemorelli/react-gtm
// Definitions by: Marc Veens <https://github.com/marcveens>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2

declare const TagManager: {
    dataLayer: (dataLayerArgs: DataLayerArgs) => void;
    initialize: (tagManagerArgs: TagManagerArgs) => void;
};

export interface TagManagerArgs extends DataLayerArgs {
    /**
     * GTM id, must be something like GTM-000000.
     */
    gtmId: string;
    /**
     * Additional events such as 'gtm.start': new Date().getTime(),event:'gtm.js'.
     */
    events?: object | undefined;
    /**
     * Used to set environments.
     */
    auth?: string | undefined;
    /**
     * Used to set environments, something like env-00.
     */
    preview?: string | undefined;
}

export interface DataLayerArgs {
    /**
     * Object that contains all of the information that you want to pass to Google Tag Manager.
     */
    dataLayer?: object | undefined;
    /**
     * Custom name for dataLayer object.
     */
    dataLayerName?: string | undefined;
}

export default TagManager;

Additional Details

  • Last updated: Wed, 07 Jul 2021 17:33:43 GMT
  • Dependencies: none
  • Global values: none

Credits

These definitions were written by Marc Veens.