@firebolt-js/openrpc
Advanced tools
Comparing version 1.7.0 to 1.7.1-next.1
@@ -0,1 +1,25 @@ | ||
## [1.7.1-next.1](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.7.0...v1.7.1-next.1) (2022-11-18) | ||
### Bug Fixes | ||
* Capabilities for property setters to be manages instead of uses ([#77](https://github.com/rdkcentral/firebolt-openrpc/issues/77)) ([a2fa157](https://github.com/rdkcentral/firebolt-openrpc/commit/a2fa157fac3ace0c3cec9f283b59bc4768e17373)) | ||
* Properly document context params ([#75](https://github.com/rdkcentral/firebolt-openrpc/issues/75)) ([325858c](https://github.com/rdkcentral/firebolt-openrpc/commit/325858c98116edd4708eacce644bbdb95a2e18e4)) | ||
* Trigger semantic release ([bb2ab26](https://github.com/rdkcentral/firebolt-openrpc/commit/bb2ab26b76e7515c0770f79d0ea65a436c930915)) | ||
# [1.7.0-next.7](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.7.0-next.6...v1.7.0-next.7) (2022-11-18) | ||
### Bug Fixes | ||
* Trigger semantic release ([bb2ab26](https://github.com/rdkcentral/firebolt-openrpc/commit/bb2ab26b76e7515c0770f79d0ea65a436c930915)) | ||
# [1.7.0-next.6](https://github.com/rdkcentral/firebolt-openrpc/compare/v1.7.0-next.5...v1.7.0-next.6) (2022-11-18) | ||
### Bug Fixes | ||
* Capabilities for property setters to be manages instead of uses ([#77](https://github.com/rdkcentral/firebolt-openrpc/issues/77)) ([a2fa157](https://github.com/rdkcentral/firebolt-openrpc/commit/a2fa157fac3ace0c3cec9f283b59bc4768e17373)) | ||
* Properly document context params ([#75](https://github.com/rdkcentral/firebolt-openrpc/issues/75)) ([325858c](https://github.com/rdkcentral/firebolt-openrpc/commit/325858c98116edd4708eacce644bbdb95a2e18e4)) | ||
## 1.7.0 | ||
@@ -2,0 +26,0 @@ |
{ | ||
"name": "@firebolt-js/openrpc", | ||
"version": "1.7.0", | ||
"version": "1.7.1-next.1", | ||
"description": "The Firebolt SDK Code & Doc Generator", | ||
@@ -5,0 +5,0 @@ "main": "src/js/sdk/index.mjs", |
@@ -6,3 +6,3 @@ ### ${method.name} | ||
To get the value, call the method with no parameters: | ||
To get the value of `${method.name}` call the method like this: | ||
@@ -12,3 +12,3 @@ ${if.javascript} | ||
```typescript | ||
function ${method.name}(): Promise<${method.result.type}> | ||
${method.signature} | ||
``` | ||
@@ -18,2 +18,12 @@ | ||
${if.params} | ||
Parameters: | ||
| Param | Type | Required | Summary | | ||
| ---------------------- | -------------------- | ------------------------ | ----------------------- | | ||
| `${method.param.name}` | ${method.param.type} | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | | ||
${end.if.params} | ||
Promise resolution: | ||
@@ -62,3 +72,3 @@ | ||
${method.2} | ||
To set the value, pass in the new value as the only parameter: | ||
To set the value of `${method.name}` call the method like this: | ||
@@ -68,3 +78,3 @@ ${if.javascript} | ||
```typescript | ||
function ${method.name}(${method.params}): Promise<void> | ||
${method.signature} | ||
``` | ||
@@ -98,5 +108,2 @@ | ||
${module}.${method.name}(${example.params}) | ||
.then(${method.result.name} => { | ||
// property value has been set | ||
}) | ||
``` | ||
@@ -127,3 +134,3 @@ | ||
${method.3} | ||
To subscribe to notifications when the value changes, pass a function as the only parameter: | ||
To subscribe to notifications when the value changes, call the method like this: | ||
@@ -133,3 +140,3 @@ ${if.javascript} | ||
```typescript | ||
function ${method.name}(subscriber: (${method.params}) => void): Promise<boolean> | ||
function ${method.name} (${method.params} ${if.params}, ${end.if.params}subscriber: (${method.result.name}) => void): Promise<listenerId> | ||
``` | ||
@@ -143,4 +150,6 @@ | ||
| ---------------------- | -------------------- | ------------------------ | ----------------------- | | ||
| `subscriber` | `Function` | Yes | A callback that gets invoked when the value for ${method.name} changes | | ||
| `${method.param.name}` | ${method.param.type} | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | | ||
| `subscriber` | `function` | Yes | Callback to execute when the value changes. | | ||
Promise resolution: | ||
@@ -156,3 +165,3 @@ | ||
| ---------------------- | -------------------- | ------------------------ | ----------------------- | | ||
| `${method.param.name}` | ${method.param.type} | Yes | ${method.param.summary} ${method.param.constraints} | | ||
| `${method.result.name}` | `${event.result.type}` | Yes | ${method.result.summary} | | ||
@@ -170,5 +179,5 @@ **Examples** | ||
${module}.${method.name}(${method.paramNames} => { | ||
${module}.${method.name}(${method.paramNames} ${if.params}, ${end.if.params}(value) => { | ||
// property value was changed | ||
console.log(${method.paramNames}) | ||
console.log(value) | ||
}).then(listenerId => { | ||
@@ -179,3 +188,3 @@ // you can clear this listener w/ ${module}.clear(listenerId) | ||
value of `${method.paramNames}`: | ||
value of `value`: | ||
@@ -182,0 +191,0 @@ ```javascript |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
343352
76
7807
1