@kubb/studio 5.6.1 → 5.6.3

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-CRm0XQPb.js";
-import { F as SnapshotUploadMetadata, a as AgentConnectInfo, k as PublishedSnapshot, o as AgentPermissions } from "./protocol-P0znFp9w.js";
+import { F as SnapshotUploadMetadata, a as AgentConnectInfo, k as PublishedSnapshot, o as AgentPermissions } from "./protocol-i7JV0P4z.js";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/connect.d.ts
 /**
@@ -220,28 +220,18 @@ type CreateSnapshotOptions = Omit<SnapshotUploadMetadata, 'hashes' | 'peerDepend
    */
   apiKey: string;
   /**
-   * The project's Kubb config. Like `kubb generate`, it writes to `output.path`, then runs the
-   * formatter, the linter, and `output.postGenerate`.
+   * The project's Kubb config, generated like `kubb generate`: formatter, linter, and `output.postGenerate` included.
    */
   config: Config;
   hooks?: Hookable<KubbHooks>;
   signal?: AbortSignal;
 };
 /**
- * Generates the project, packs it as an npm tarball, and publishes it to Studio in one
- * `POST /api/snapshots` request.
+ * Generates the project, packs it as an npm tarball, and publishes it to Studio in one `POST /api/snapshots` request.
  *
  * @example
  * ```ts
- * const snapshot = await createSnapshot({
- *   apiKey: process.env.KUBB_TOKEN!,
- *   config,
- *   id: 'gh:123:pr-4',
- *   name: 'acme/api#4',
- *   packageName: '@acme/api',
- *   version: '1.0.0',
- * })
- * console.log(snapshot.url, snapshot.changes)
+ * const { url } = await createSnapshot({ apiKey: process.env.KUBB_TOKEN!, config, id: 'gh:123:pr-4', name: 'acme/api#4', packageName: '@acme/api', version: '1.0.0' })
  * ```
  */
 export declare function createSnapshot({ studioUrl, apiKey, config, hooks, signal, ...metadata }: CreateSnapshotOptions): Promise<PublishedSnapshot>;