Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Modified observe and unobserved to include code markdown
  • Loading branch information
aleph1 authored Dec 28, 2023
1 parent da28c0f commit b3a2dc0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ Subscribes to either the change or destroy event using callbackFn, Returns `true
Unsubscribes from either the change or destroy event using callbackFn. Returns `true` if successfully unsubscribed, or `false` in cases where the proxy or callback function is invalid.

### DEPRECATED observe(proxy: Observable, callbackFn: (proxy: Observable) => void): boolean
Shorthand method that calls observe(proxy, "change", callbackFn). Maintained for backwards compatibility with v1, but will be dropped in a future release.
Shorthand method that calls `observe(proxy, "change", callbackFn)`. Maintained for backwards compatibility with v1, but will be dropped in a future release.

### DEPRECATED unobserve(proxy: Observable, callbackFn: (proxy: Observable) => void): boolean
Shorthand method that calls unobserve(proxy, "change", callbackFn). Maintained for backwards compatibility with v1, but will be dropped in a future release.
Shorthand method that calls `unobserve(proxy, "change", callbackFn)`. Maintained for backwards compatibility with v1, but will be dropped in a future release.

### destroy(proxy: Observable): boolean
Cleans up the proxy. Returns `true` if successfully destroyed, or `false` in cases where the proxy has already been destroyed, or is not a valid proxy.
Expand Down

0 comments on commit b3a2dc0

Please sign in to comment.