Declare collection and model constructor params optional.

conversejs · Oct 31, 2023 · 88b1608 · 88b1608
1 parent 3050100
commit 88b1608
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/src/collection.js b/src/collection.js
@@ -39,8 +39,8 @@ class Collection extends EventEmitter(Object) {
    * Create a new **Collection**, perhaps to contain a specific type of `model`.
    * If a `comparator` is specified, the Collection will maintain
    * its models in sort order, as they're added and removed.
-   * @param {Model[]} models
-   * @param {CollectionOptions} options
+   * @param {Model[]} [models]
+   * @param {CollectionOptions} [options]
    */
   constructor(models, options) {
     super();

diff --git a/src/model.js b/src/model.js
@@ -38,7 +38,7 @@ class Model extends EventEmitter(Object) {
    * Create a new model with the specified attributes. A client id (`cid`)
    * is automatically generated and assigned for you.
    * @param {Attributes} attributes
-   * @param {ModelOptions} options
+   * @param {ModelOptions} [options]
    */
   constructor(attributes, options) {
     super();

diff --git a/src/types/collection.d.ts b/src/types/collection.d.ts
@@ -9,8 +9,8 @@ declare const Collection_base: {
          * Create a new **Collection**, perhaps to contain a specific type of `model`.
          * If a `comparator` is specified, the Collection will maintain
          * its models in sort order, as they're added and removed.
-         * @param {Model[]} models
-         * @param {CollectionOptions} options
+         * @param {Model[]} [models]
+         * @param {CollectionOptions} [options]
          */
         _listeners: {};
         listenTo(obj: any, name: string, callback?: (event: any, model: Model, collection: Collection, options: Record<string, any>) => any): any;
@@ -46,10 +46,10 @@ export class Collection extends Collection_base {
      * Create a new **Collection**, perhaps to contain a specific type of `model`.
      * If a `comparator` is specified, the Collection will maintain
      * its models in sort order, as they're added and removed.
-     * @param {Model[]} models
-     * @param {CollectionOptions} options
+     * @param {Model[]} [models]
+     * @param {CollectionOptions} [options]
      */
-    constructor(models: Model[], options: CollectionOptions, ...args: any[]);
+    constructor(models?: Model[], options?: CollectionOptions, ...args: any[]);
     _model: any;
     comparator: any;
     /**

diff --git a/src/types/collection.d.ts.map b/src/types/collection.d.ts.map
diff --git a/src/types/model.d.ts b/src/types/model.d.ts
@@ -60,9 +60,9 @@ export class Model extends Model_base {
      * Create a new model with the specified attributes. A client id (`cid`)
      * is automatically generated and assigned for you.
      * @param {Attributes} attributes
-     * @param {ModelOptions} options
+     * @param {ModelOptions} [options]
      */
-    constructor(attributes: Attributes, options: ModelOptions, ...args: any[]);
+    constructor(attributes: Attributes, options?: ModelOptions, ...args: any[]);
     cid: any;
     attributes: {};
     validationError: any;

diff --git a/src/types/model.d.ts.map b/src/types/model.d.ts.map