Added initial types for react-gtm-module (#35620)

* Added types for react-gtm-module

* Fixed some tslint issues
This commit is contained in:
Marc Veens 2019-05-22 18:19:00 +02:00 committed by Ryan Cavanaugh
parent 2f577f967c
commit c0a7ca952f
4 changed files with 86 additions and 0 deletions

42
types/react-gtm-module/index.d.ts vendored Normal file
View File

@ -0,0 +1,42 @@
// 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;

View File

@ -0,0 +1,19 @@
import TagManager from 'react-gtm-module';
TagManager.initialize({
gtmId: 'GTM-000000'
});
TagManager.initialize({
gtmId: 'GTM-000000',
events: {},
auth: '',
preview: '',
dataLayer: {},
dataLayerName: ''
});
TagManager.dataLayer({
dataLayer: {},
dataLayerName: ''
});

View File

@ -0,0 +1,24 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"baseUrl": "../",
"jsx": "react",
"typeRoots": [
"../"
],
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"react-gtm-module-tests.tsx"
]
}

View File

@ -0,0 +1 @@
{ "extends": "dtslint/dt.json" }