JS-0107 · Prefer grouped accessor pairs in object literals and classes

Prefer grouped accessor pairs in object literals and classes JS-0107

Anti-pattern

Minor

15 days ago — 3 years old

Accessor pair setter 'rightMouseTool' and getter 'rightMouseTool' should be grouped

 69     * @returns Returns right mouse tool
 70     * @memberof MouseAndKeyboardHandler
 71     */
 72    get rightMouseTool() { 73        return this.__rightMouseTool;
 74    }
 75

Accessor pair setter 'leftMouseTool' and getter 'leftMouseTool' should be grouped

src/app/view/mouseAndKeyboardHandler.ts

 60     * @returns Returns left mouse tool
 61     * @memberof MouseAndKeyboardHandler
 62     */
 63    get leftMouseTool() { 64        return this.__leftMouseTool;
 65    }
 66

Accessor pair setter 'dxfObjects' and getter 'dxfObjects' should be grouped

src/app/core/feature.ts

190     * @returns {DXFObject}
191     * @memberof Feature
192     */
193    get dxfObjects() {194        return this._dxfObjects;
195    }
196

Accessor pair getter 'name' and setter 'name' should be grouped

src/app/core/device.ts

 199     * @param {string} name Name of the device
 200     * @memberof Device
 201     */
 202    set name(name: string) { 203        this.__name = name;
 204    }
 205

Accessor pair getter 'params' and setter 'params' should be grouped

src/app/core/connection.ts

313     * @returns {void}
314     * @memberof Connection
315     */
316    set params(params: Params) {317        this._params = params;
318        //TODO: Modify all the associated Features
319        for (let key in params) {

Description

A getter and setter for the same property don't necessarily have to be defined adjacent to each other.

For example, the following statements would create the same object:

var o = {
    get a() {
        return this.val;
    },
    set a(value) {
        this.val = value;
    },
    b: 1
};

var o = {
    get a() {
        return this.val;
    },
    b: 1,
    set a(value) {
        this.val = value;
    }
};

While it is allowed to define the pair for a getter or a setter anywhere in an object or class definition, it's considered a best practice to group accessor functions for the same property.

Bad Practice

var foo = {
    get a() {
        return this.val;
    },
    b: 1,
    set a(value) {
        this.val = value;
    }
};

var bar = {
    set b(value) {
        this.val = value;
    },
    a: 1,
    get b() {
        return this.val;
    }
}

class Foo {
    set a(value) {
        this.val = value;
    }
    b(){}
    get a() {
        return this.val;
    }
}

const Bar = class {
    static get a() {
        return this.val;
    }
    b(){}
    static set a(value) {
        this.val = value;
    }
}

var foo = {
    get a() {
        return this.val;
    },
    set a(value) {
        this.val = value;
    },
    b: 1
};

var bar = {
    set b(value) {
        this.val = value;
    },
    get b() {
        return this.val;
    },
    a: 1
}

class Foo {
    set a(value) {
        this.val = value;
    }
    get a() {
        return this.val;
    }
    b(){}
}

const Bar = class {
    static get a() {
        return this.val;
    }
    static set a(value) {
        this.val = value;
    }
    b(){}
}

CIDARLAB / 3DuF

Bad Practice

Recommended