@microsoft/rayfin-functions 1.32.0 → 1.33.0-beta.0

package/dist/FunctionClient.d.ts

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Per-function typed client.
+ * @packageDocumentation Per-function typed client.
  *
  * Each property on the proxy returned by `createFunctionsApi` is a
  * `FunctionClient` whose `invoke()` signature is derived from the schema
@@ -35,8 +35,8 @@ export interface InvokeOptions {
 /**
  * A strongly-typed client for a single function.
  *
- * @template TInput  - The parameter object the function expects (`void` when none).
- * @template TOutput - The type returned by the function.
+ * @typeParam TInput - The parameter object the function expects (`void` when none).
+ * @typeParam TOutput - The type returned by the function.
  */
 export declare class FunctionClient<TInput = any, TOutput = any> {
     private apiClient;
@@ -45,8 +45,11 @@ export declare class FunctionClient<TInput = any, TOutput = any> {
     /**
      * Invoke the function and return its typed output.
      *
-     * @param params   - Input parameters (omit when the function takes no input).
-     * @param options  - Optional per-call settings (extra headers, etc.).
+     * @param args - When the function accepts input, pass
+     *   `[params, options?]` — `params` are the input parameters declared
+     *   by the function schema, `options` are optional per-call settings
+     *   (extra headers, etc.). When the function takes no input, pass
+     *   `[options?]` instead.
      * @returns The function's success-path output, typed as `TOutput`.
      *
      * Failure modes throw — a non-empty `errors` array or a non-success
@@ -61,9 +64,9 @@ export declare class FunctionClient<TInput = any, TOutput = any> {
      * value is available in the browser/Node console for correlation
      * without polluting the public return type.
      *
-     * @throws {FunctionsError} If the function invocation fails.
-     * @throws {NetworkError}   For network-related issues.
-     * @throws {SdkError}       For any other unexpected SDK errors.
+     * @throws {@link FunctionsError} - If the function invocation fails.
+     * @throws `NetworkError` - For network-related issues.
+     * @throws `SdkError` - For any other unexpected SDK errors.
      *
      * @example
      * ```typescript

package/dist/FunctionClient.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Per-function typed client.
+ * @packageDocumentation Per-function typed client.
  *
  * Each property on the proxy returned by `createFunctionsApi` is a
  * `FunctionClient` whose `invoke()` signature is derived from the schema
@@ -11,8 +11,8 @@ import { FunctionsError } from './Functions.js';
 /**
  * A strongly-typed client for a single function.
  *
- * @template TInput  - The parameter object the function expects (`void` when none).
- * @template TOutput - The type returned by the function.
+ * @typeParam TInput - The parameter object the function expects (`void` when none).
+ * @typeParam TOutput - The type returned by the function.
  */
 export class FunctionClient {
     apiClient;
@@ -24,8 +24,11 @@ export class FunctionClient {
     /**
      * Invoke the function and return its typed output.
      *
-     * @param params   - Input parameters (omit when the function takes no input).
-     * @param options  - Optional per-call settings (extra headers, etc.).
+     * @param args - When the function accepts input, pass
+     *   `[params, options?]` — `params` are the input parameters declared
+     *   by the function schema, `options` are optional per-call settings
+     *   (extra headers, etc.). When the function takes no input, pass
+     *   `[options?]` instead.
      * @returns The function's success-path output, typed as `TOutput`.
      *
      * Failure modes throw — a non-empty `errors` array or a non-success
@@ -40,9 +43,9 @@ export class FunctionClient {
      * value is available in the browser/Node console for correlation
      * without polluting the public return type.
      *
-     * @throws {FunctionsError} If the function invocation fails.
-     * @throws {NetworkError}   For network-related issues.
-     * @throws {SdkError}       For any other unexpected SDK errors.
+     * @throws {@link FunctionsError} - If the function invocation fails.
+     * @throws `NetworkError` - For network-related issues.
+     * @throws `SdkError` - For any other unexpected SDK errors.
      *
      * @example
      * ```typescript

package/dist/Functions.d.ts

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Functions API for invoking serverless functions.
+ * @packageDocumentation Functions API for invoking serverless functions.
  *
  * The single public surface is `client.functions.<name>.invoke(...)` where
  * `<name>` is constrained by the `FunctionsSchema` type parameter passed to

package/dist/Functions.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Functions API for invoking serverless functions.
+ * @packageDocumentation Functions API for invoking serverless functions.
  *
  * The single public surface is `client.functions.<name>.invoke(...)` where
  * `<name>` is constrained by the `FunctionsSchema` type parameter passed to

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/rayfin-functions",
-  "version": "1.32.0",
+  "version": "1.33.0-beta.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,7 +19,7 @@
     "rimraf": "~6.0.1"
   },
   "dependencies": {
-    "@microsoft/rayfin-lib": "1.32.0"
+    "@microsoft/rayfin-lib": "1.33.0-beta.0"
   },
   "publishConfig": {
     "registry": "https://npm.pkg.github.com",