Skip to content

What's difference between @computed decorator and getter function #161

Closed
@boatkorachal

Description

@boatkorachal

I'm not sure when should i use the @computed decorator (without asStructure option) in class instead of the getter function for example

class Test {
    @observable firstName = 'first'
    @observable lastName = 'last'

    @computed
    get fullName () {
        return `${this.firstName} ${this.lastName}`
    }

    getFullName () {
        return `${this.firstName} ${this.lastName}`
    }
}

const test = new Test()
autorun(() => {
    console.log('computed:', test.fullName)
})

autorun(() => {
    console.log('getter:', test.getFullName())
})

test.firstName = 'salmon'
test.lastName = 'sushi'

// computed: first last
// getter: first last
// computed: salmon last
// getter: salmon last
// computed: salmon sushi
// getter: salmon sushi

Thanks

Activity

OscarBarrett

OscarBarrett commented on Mar 15, 2016

@OscarBarrett

From the docs

use @computed if you want to reactively produce a new value that can be used by other observers

...

Computed properties can be optimized away in many cases by MobX as they are assumed to be pure. So they will not be invoked when there input parameters didn't modifiy or if they are not observed by some other computed value or autorun.

So if you're going to observe it, make it a computed property.

boatkorachal

boatkorachal commented on Mar 15, 2016

@boatkorachal
Author

What I think is firstName and lastName is being observed in both computed and getter function. At first I thought the use case is for optimize as the docs said that the computed properties will not invoked when there input parameters didn't modify.

class Test {
    @observable firstName = 'first'
    @observable lastName = 'last'

    @computed
    get fullName () {
        return `${this.firstName} ${this.lastName}`
    }

    getFullName () {
        return `${this.firstName} ${this.lastName}`
    }
}

const test = new Test()
autorun(() => {
    console.log('computed:', test.fullName)
})

autorun(() => {
    console.log('getter:', test.getFullName())
})

test.firstName = 'salmon'
test.lastName = 'sushi'

test.firstName = 'salmon' // <---- again

// computed: first last
// getter: first last
// computed: salmon last
// getter: salmon last
// computed: salmon sushi
// getter: salmon sushi

But after I tried, the getter function didn't print duplicate fullName when I assign the firstName "salmon" again.

Thanks.

mweststrate

mweststrate commented on Mar 15, 2016

@mweststrate
Member

Both solutions will exhibit the same behavior, but introducing @computed is better in the sense that it allows MobX to optimized it away more smartly.

If getFullName is not computed, and you change firstName, everyone using getFullName will recompute as well.

If, in contrast, @computed get fullName is used, the fullname is cached, so if the firstname is changed, the fullname is recomputed as well, but if the output of fullname doesn't change, nobody would be notified.

Also, if you read test.fullName somwhere, you will (usually) get a cached result back if decorated, while without decorator it would always be recomputed (which is the normal function behavior after all)

So, when in doubt, use it (if your function is pure in terms of depending only on observable values, which it should be)

boatkorachal

boatkorachal commented on Mar 15, 2016

@boatkorachal
Author

Got it! thank you very much :)

ghost

ghost commented on Jul 25, 2017

@ghost

@mweststrate so it seems there is not much difference between using a computed decorator and a simple getter? (besides optimization?)

mweststrate

mweststrate commented on Jul 26, 2017

@mweststrate
Member
DmitryOlkhovoi

DmitryOlkhovoi commented on Nov 26, 2017

@DmitryOlkhovoi

nobody would be notified.

Who can be notified? I tried hard, and every time I get not a cached value. So I confused :)

@mweststrate

windwalker

windwalker commented on Jan 4, 2018

@windwalker

@mweststrate

Also, if you read test.fullName somwhere, you will (usually) get a cached result back if decorated, while without decorator it would always be recomputed (which is the normal function behavior after all)

When would I get a cached result instead of getting the function recomputed? I tried the following example and it recomputes.

const {observable, computed} = mobx;

class Test {
    @observable firstName = 'first'
    @observable lastName = 'last'

    @computed
    get fullName () {
    	console.log('recompute fullname');
        return `${this.firstName} ${this.lastName}`
    }
}

let test = new Test()

console.log(test.fullName);
//recompute fullname
//first last

console.log(test.fullName);
//recompute fullname
//first last
royriojas

royriojas commented on Jan 5, 2018

@royriojas

@windwalker I was confused by that too, but it seems values are cached when used inside a reaction, autorun or in the render of an observable React component.

Something like https://jsbin.com/rujuxe/edit?js,console,output you can see that the computed values are only called once even when we show then twice.

Also the value will be reevaluated if called directly. (check the click handler of the button)

@mweststrate are there any plans to also return a cached value from the normal usages outside of autorun, reaction and render?

mweststrate

mweststrate commented on Jan 5, 2018

@mweststrate
Member
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @royriojas@windwalker@boatkorachal@mweststrate@OscarBarrett

        Issue actions

          What's difference between @computed decorator and getter function · Issue #161 · mobxjs/mobx