Update document.d.ts set function params

[jeffersonlipsky]

/**
 * Alias for `set()`, used internally to avoid conflicts *
 * @param {String|Object} path path or object of key/vals to set
 * @param {Any} val the value to set
 * @param {Schema|String|Number|Buffer|*} [type] optionally specify a type for "on-the-fly" attributes
 * @param {Object} [options] optionally specify options that modify the behavior of the set
 * @param {Boolean} [options.merge=false] if true, setting a [nested path](/docs/subdocs.html#subdocuments-versus-nested-paths) will merge existing values rather than overwrite the whole object. So `doc.set('nested', { a: 1, b: 2 })` becomes `doc.set('nested.a', 1); doc.set('nested.b', 2);`
 * @return {Document} this
 * @method $set
 * @memberOf Document
 * @instance
 * @api public */

Summary

Examples

[hasezoey]

Looks good to me, maybe consider adding some type tests so that it does not get forgotten in the future

[vkarpov15]

This isn't quite correct, Mongoose ignores val if path is an object. So I think the more correct approach would be to add an additional override to $set() that looks like this:

$set(Record<string, any>, val?: null | undefined, type?: any, options?: DocumentSetOptions): this;

What do you think?

[hasezoey]

This isn't quite correct, Mongoose ignores val if path is an object.

if i understand it correctly, a additional overload would be needed like

$set(path: Record<string, any>, type: any, options?: DocumentSetOptions): this;

or is type not just assigned from parameter 2 and still needs val: never?

[vkarpov15]

LGTM. I took a closer look and, in order to apply the changes I suggested, we'd also need to change the function signature for set(), and I'd rather not do that for now. Given that this makes our types more consistent, I'm going to merge this as is.