Skip to content

Add typescript types for InitConfig #220

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add typescript types for InitConfig #220

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3f2a57
Add types for InitConfig
davidbielik Jul 13, 2023
580283d
Update mixpanel-node.d.ts
davidbielik Jul 13, 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
19 changes: 18 additions & 1 deletion lib/mixpanel-node.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,24 @@ declare namespace mixpanel {
type Scalar = string | number | boolean;

export interface InitConfig {
[key: string]: any;
/* Defaults to `false` */
test?: boolean;
/* Defaults to `false` */
debug?: boolean;
/* Enable verbose logging - defaults to `false` */
verbose?: boolean;
/* API hostname - defaults to `"api.mixpanel.com"` */
host?: string;
/* API protocol - defaults to `"https"` */
protocol?: string;
/* API pathname - defaults to `""` */
path?: '';
/* request keepAlive setting - defaults to `true` */
keepAlive?: boolean;
/** Geolocate based on client IP (e.g. when running in Electron) - defaults to `false`.
* To supply the user's IP manually, set to false and provide the `$ip` property instead.
**/
geolocate?: false;
}

export interface PropertyDict {
Expand Down