Skip to content

Commit

Permalink
docs: improve getter return type
Browse files Browse the repository at this point in the history
  • Loading branch information
posva committed Mar 4, 2024
1 parent f695b62 commit 66760f7
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions packages/docs/core-concepts/getters.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,28 @@ const store = useCounterStore()

## Accessing other getters

As with computed properties, you can combine multiple getters. Access any other getter via `this`. Even if you are not using TypeScript, you can hint your IDE for types with the [JSDoc](https://jsdoc.app/tags-returns.html):
As with computed properties, you can combine multiple getters. Access any other getter via `this`. In this scenario, **you will need to specify a return type** for the getter.

```js
::: code-group

```ts [counterStore.ts]
export const useCounterStore = defineStore('counter', {
state: () => ({
count: 0,
}),
getters: {
doubleCount(state) {
return state.count * 2
},
doubleCountPlusOne(): number {
return this.doubleCount + 1
},
},
})
```

```js [counterStore.js]
// You can use [JSDoc](https://jsdoc.app/tags-returns.html) in JavaScript
export const useCounterStore = defineStore('counter', {
state: () => ({
count: 0,
Expand All @@ -80,6 +99,8 @@ export const useCounterStore = defineStore('counter', {
})
```

:::

## Passing arguments to getters

_Getters_ are just _computed_ properties behind the scenes, so it's not possible to pass any parameters to them. However, you can return a function from the _getter_ to accept any arguments:
Expand Down

0 comments on commit 66760f7

Please sign in to comment.