Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add @this decorator to syntax lookup #180

Merged
merged 3 commits into from
Jan 15, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions misc_docs/syntax/decorator_this.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
id: "this-decorator"
keywords: ["this", "decorator"]
name: "@this"
summary: "This is the `@this` decorator."
category: "decorators"
---

The `@this` decorator may be used to bind to an **external** callback function that require access to a `this` context.

### Example

<CodeTab labels={["ReScript", "JS Output"]}>

```res
type counter

// Function to create an empty object
@new external create: unit => counter = "Object"

// Functions that set and get a "value" property
@set external setValue: (counter, int) => unit = "value"
@get external getValue: counter => int = "value"

// Functions that create "increment" and "decrement" function properties which have access to "this"
@set external setIncrement: (counter, @this (counter, int) => unit) => unit = "increment"
@set external setDecrement: (counter, @this (counter, int) => unit) => unit = "decrement"

// Use the functions above to create a counter instance
let counter = create()
setValue(counter, 0)
setIncrement(counter, @this (me, amount) => me->setValue(me->getValue + amount))
setDecrement(counter, @this (me, amount) => me->setValue(me->getValue - amount))
```

```js
var counter = new Object()

counter.value = 0

counter.increment = function (amount) {
var me = this
me.value = (me.value + amount) | 0
}

counter.decrement = function (amount) {
var me = this
me.value = (me.value - amount) | 0
}
```

</CodeTab>

### References

* [Modeling `this`-based Callbacks](/docs/manual/latest/bind-to-js-function#modeling-this-based-callbacks)