DefinitelyTyped/types/react-gtm-module/index.d.ts
Marc Veens c0a7ca952f Added initial types for react-gtm-module (#35620)
* Added types for react-gtm-module

* Fixed some tslint issues
2019-05-22 09:19:00 -07:00

43 lines
1.1 KiB
TypeScript

// 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;
/**
* Used to set environments.
*/
auth?: string;
/**
* Used to set environments, something like env-00.
*/
preview?: string;
}
export interface DataLayerArgs {
/**
* Object that contains all of the information that you want to pass to Google Tag Manager.
*/
dataLayer?: object;
/**
* Custom name for dataLayer object.
*/
dataLayerName?: string;
}
export default TagManager;