Add warning in docstring

rekmarks · rekmarks · commit 9b6d3920d354 · 2021-05-17T19:50:57.000-07:00
diff --git a/src/utils.ts b/src/utils.ts
@@ -6,6 +6,9 @@ import type {
 } from './JsonRpcEngine';
 
 /**
+ * **ATTN:** Assumes that only one of the `result` and `error` properties are
+ * present on the `response`, as guaranteed by e.g. `JsonRpcEngine.handle`.
+ *
  * Type guard to narrow a JsonRpcResponse object to a success (or failure).
  *
  * @param response - The response object to check.
@@ -19,6 +22,9 @@ export function isJsonRpcSuccess<T>(
 }
 
 /**
+ * **ATTN:** Assumes that only one of the `result` and `error` properties are
+ * present on the `response`, as guaranteed by e.g. `JsonRpcEngine.handle`.
+ *
  * Type guard to narrow a JsonRpcResponse object to a failure (or success).
  *
  * @param response - The response object to check.

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@ import type {`
`6`	`6`	`} from './JsonRpcEngine';`
`7`	`7`
`8`	`8`	`/**`
	`9`	+ * ATTN: Assumes that only one of the `result` and `error` properties are
	`10`	+ * present on the `response`, as guaranteed by e.g. `JsonRpcEngine.handle`.
	`11`	`+ *`
`9`	`12`	`* Type guard to narrow a JsonRpcResponse object to a success (or failure).`
`10`	`13`	`*`
`11`	`14`	`* @param response - The response object to check.`
`@@ -19,6 +22,9 @@ export function isJsonRpcSuccess<T>(`
`19`	`22`	`}`
`20`	`23`
`21`	`24`	`/**`
	`25`	+ * ATTN: Assumes that only one of the `result` and `error` properties are
	`26`	+ * present on the `response`, as guaranteed by e.g. `JsonRpcEngine.handle`.
	`27`	`+ *`
`22`	`28`	`* Type guard to narrow a JsonRpcResponse object to a failure (or success).`
`23`	`29`	`*`
`24`	`30`	`* @param response - The response object to check.`