Change the args of the main methods to be optional (#203)

Author: Rowno

HISTORY.md

@@ -1,3 +1,7 @@
+# 4.0.4 / 2020-09-11
+
+- Change the arguments of the main methods to be optional in the typedef to match the documentation. (#203)
+
 # 4.0.3 / 2020-09-11
 
 - Bump `debug` to a version that fixed security vulnerabilities.

lib/analytics.ts

@@ -297,10 +297,10 @@ Analytics.prototype.add = function(integration: {
  */
 
 Analytics.prototype.identify = function(
-  id: string,
-  traits: unknown,
-  options: SegmentOpts,
-  fn: Function | SegmentOpts
+  id?: string,
+  traits?: unknown,
+  options?: SegmentOpts,
+  fn?: Function | SegmentOpts
 ): SegmentAnalytics {
   // Argument reshuffling.
   /* eslint-disable no-unused-expressions, no-sequences */
@@ -355,9 +355,9 @@ Analytics.prototype.user = function(): object {
 
 Analytics.prototype.group = function(
   id: string,
-  traits: unknown,
-  options: unknown,
-  fn: unknown
+  traits?: unknown,
+  options?: unknown,
+  fn?: unknown
 ): SegmentAnalytics {
   /* eslint-disable no-unused-expressions, no-sequences */
   if (!arguments.length) return group;
@@ -399,9 +399,9 @@ Analytics.prototype.group = function(
 
 Analytics.prototype.track = function(
   event: string,
-  properties: unknown,
-  options: unknown,
-  fn: unknown
+  properties?: unknown,
+  options?: unknown,
+  fn?: unknown
 ): SegmentAnalytics {
   // Argument reshuffling.
   /* eslint-disable no-unused-expressions, no-sequences */
@@ -564,11 +564,11 @@ Analytics.prototype.trackSubmit = Analytics.prototype.trackForm = function(
  */
 
 Analytics.prototype.page = function(
-  category: string,
-  name: string,
-  properties: any,
-  options: any,
-  fn: unknown
+  category?: string,
+  name?: string,
+  properties?: any,
+  options?: any,
+  fn?: unknown
 ): SegmentAnalytics {
   // Argument reshuffling.
   /* eslint-disable no-unused-expressions, no-sequences */

lib/index.d.ts

@@ -130,10 +130,10 @@ export declare namespace SegmentAnalytics {
      * Identify a user by optional `id` and `traits`.
      */
     identify(
-      id: string,
-      traits: unknown,
-      options: SegmentOpts,
-      fn: Function | SegmentOpts
+      id?: string,
+      traits?: unknown,
+      options?: SegmentOpts,
+      fn?: Function | SegmentOpts
     ): AnalyticsJS;
 
     /**
@@ -147,19 +147,19 @@ export declare namespace SegmentAnalytics {
      */
     group(
       id: string,
-      traits: unknown,
-      options: unknown,
-      fn: unknown
+      traits?: unknown,
+      options?: unknown,
+      fn?: unknown
     ): AnalyticsJS;
 
     /**
      * Track an `event` that a user has triggered with optional `properties`.
      */
     track(
       event: string,
-      properties: unknown,
-      options: unknown,
-      fn: unknown
+      properties?: unknown,
+      options?: unknown,
+      fn?: unknown
     ): AnalyticsJS;
 
     /**
@@ -220,11 +220,11 @@ export declare namespace SegmentAnalytics {
      * `name` and `properties`.
      */
     page(
-      category: string,
-      name: string,
-      properties: any,
-      options: any,
-      fn: unknown
+      category?: string,
+      name?: string,
+      properties?: any,
+      options?: any,
+      fn?: unknown
     ): AnalyticsJS;
 
     /**

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-core",
   "author": "Segment <[email protected]>",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "The hassle-free way to integrate analytics into any web application.",
   "types": "lib/index.d.ts",
   "keywords": [