Skip to content

[gtag.js] Replace function overload with generics #66939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 2 commits into from
Oct 6, 2023
Merged

[gtag.js] Replace function overload with generics #66939

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
355d537
replace overloads with generics
HugeLetters Oct 5, 2023
d335d83
prettier
HugeLetters Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 58 additions & 58 deletions types/gtag.js/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@

declare var gtag: Gtag.Gtag;
declare namespace Gtag {
interface Gtag {
(command: "config", targetId: string, config?: ControlParams | EventParams | ConfigParams | CustomParams): void;
(command: "set", targetId: string, config: CustomParams | boolean | string): void;
(command: "set", config: CustomParams): void;
(command: "js", config: Date): void;
(
command: "event",
eventName: EventNames | (string & {}),
eventParams?: ControlParams | EventParams | CustomParams,
): void;
(
command: "get",
interface GtagCommands {
config: [targetId: string, config?: ControlParams | EventParams | ConfigParams | CustomParams];
// eslint-disable-next-line @definitelytyped/no-single-element-tuple-type
set: [targetId: string, config: CustomParams | boolean | string] | [config: CustomParams];
Comment thread
HugeLetters marked this conversation as resolved.
Resolved
// eslint-disable-next-line @definitelytyped/no-single-element-tuple-type
js: [config: Date];
event: [eventName: EventNames | (string & {}), eventParams?: ControlParams | EventParams | CustomParams];
get: [
targetId: string,
fieldName: FieldNames | string,
callback?: (field: string | CustomParams | undefined) => any,
): void;
(command: "consent", consentArg: ConsentArg | string, consentParams: ConsentParams): void;
];
consent: [consentArg: ConsentArg | (string & {}), consentParams: ConsentParams];
}

interface Gtag {
<Command extends keyof GtagCommands>(command: Command, ...args: GtagCommands[Command]): void;
}

interface ConfigParams {
Expand All @@ -44,43 +44,43 @@ declare namespace Gtag {
}

type EventNames =
| "add_payment_info"
| "add_shipping_info"
| "add_to_cart"
| "add_to_wishlist"
| "begin_checkout"
| "checkout_progress"
| "earn_virtual_currency"
| "exception"
| "generate_lead"
| "join_group"
| "level_end"
| "level_start"
| "level_up"
| "login"
| "page_view"
| "post_score"
| "purchase"
| "refund"
| "remove_from_cart"
| "screen_view"
| "search"
| "select_content"
| "select_item"
| "select_promotion"
| "set_checkout_option"
| "share"
| "sign_up"
| "spend_virtual_currency"
| "tutorial_begin"
| "tutorial_complete"
| "unlock_achievement"
| "timing_complete"
| "view_cart"
| "view_item"
| "view_item_list"
| "view_promotion"
| "view_search_results";
| 'add_payment_info'
| 'add_shipping_info'
| 'add_to_cart'
| 'add_to_wishlist'
| 'begin_checkout'
| 'checkout_progress'
| 'earn_virtual_currency'
| 'exception'
| 'generate_lead'
| 'join_group'
| 'level_end'
| 'level_start'
| 'level_up'
| 'login'
| 'page_view'
| 'post_score'
| 'purchase'
| 'refund'
| 'remove_from_cart'
| 'screen_view'
| 'search'
| 'select_content'
| 'select_item'
| 'select_promotion'
| 'set_checkout_option'
| 'share'
| 'sign_up'
| 'spend_virtual_currency'
| 'tutorial_begin'
| 'tutorial_complete'
| 'unlock_achievement'
| 'timing_complete'
| 'view_cart'
| 'view_item'
| 'view_item_list'
| 'view_promotion'
| 'view_search_results';

interface EventParams {
checkout_option?: string | undefined;
Expand Down Expand Up @@ -150,21 +150,21 @@ declare namespace Gtag {
promotion_name?: string | undefined;
}

type FieldNames = "client_id" | "session_id" | "gclid";
type FieldNames = 'client_id' | 'session_id' | 'gclid';

type ConsentArg = "default" | "update";
type ConsentArg = 'default' | 'update';

/**
* Reference:
* @see {@link https://support.google.com/tagmanager/answer/10718549#consent-types consent-types}
* @see {@link https://developers.google.com/tag-platform/devguides/consent consent}
*/
interface ConsentParams {
ad_storage?: "granted" | "denied" | undefined;
analytics_storage?: "granted" | "denied" | undefined;
functionality_storage?: "granted" | "denied" | undefined;
personalization_storage?: "granted" | "denied" | undefined;
security_storage?: "granted" | "denied" | undefined;
ad_storage?: 'granted' | 'denied' | undefined;
analytics_storage?: 'granted' | 'denied' | undefined;
functionality_storage?: 'granted' | 'denied' | undefined;
personalization_storage?: 'granted' | 'denied' | undefined;
security_storage?: 'granted' | 'denied' | undefined;
wait_for_update?: number | undefined;
region?: string[] | undefined;
}
Expand Down