@medplum/mock 4.1.6 → 4.1.8

package/dist/cjs/index.d.ts

@@ -335,7 +335,42 @@ export declare class MockClient extends MedplumClient {
     setProfile(profile: ProfileResource | undefined): void;
     getActiveLogin(): LoginState | undefined;
     getLogins(): LoginState[];
-    createBinary(arg1: BinarySource | CreateBinaryOptions, arg2: string | undefined | MedplumRequestOptions, arg3?: string, arg4?: (e: ProgressEvent) => void): Promise<WithId<Binary>>;
+    /**
+     * Creates a FHIR `Binary` resource with the provided data content.
+     *
+     * The return value is the newly created resource, including the ID and meta.
+     *
+     * The `data` parameter can be a string or a `File` object.
+     *
+     * A `File` object often comes from a `<input type="file">` element.
+     *
+     * @example
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.createBinary(myFile, 'test.jpg', 'image/jpeg');
+     * console.log(result.id);
+     * ```
+     *
+     * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
+     *
+     * @category Create
+     * @param createBinaryOptions -The binary options. See `CreateBinaryOptions` for full details.
+     * @param requestOptions - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     */
+    createBinary(createBinaryOptions: CreateBinaryOptions, requestOptions?: MedplumRequestOptions): Promise<WithId<Binary>>;
+    /**
+     * @category Create
+     * @param data - The binary data to upload.
+     * @param filename - Optional filename for the binary.
+     * @param contentType - Content type for the binary.
+     * @param onProgress - Optional callback for progress events. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @param options - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     * @deprecated Use `createBinary` with `CreateBinaryOptions` instead. To be removed in a future version.
+     */
+    createBinary(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<WithId<Binary>>;
     pushToAgent(agent: Agent | Reference<Agent>, destination: Device | Reference<Device> | string, body: any, contentType?: string, _waitForResponse?: boolean, _options?: MedplumRequestOptions): Promise<any>;
     setAgentAvailable(value: boolean): void;
     getSubscriptionManager(): MockSubscriptionManager;

package/dist/esm/index.d.ts

@@ -335,7 +335,42 @@ export declare class MockClient extends MedplumClient {
     setProfile(profile: ProfileResource | undefined): void;
     getActiveLogin(): LoginState | undefined;
     getLogins(): LoginState[];
-    createBinary(arg1: BinarySource | CreateBinaryOptions, arg2: string | undefined | MedplumRequestOptions, arg3?: string, arg4?: (e: ProgressEvent) => void): Promise<WithId<Binary>>;
+    /**
+     * Creates a FHIR `Binary` resource with the provided data content.
+     *
+     * The return value is the newly created resource, including the ID and meta.
+     *
+     * The `data` parameter can be a string or a `File` object.
+     *
+     * A `File` object often comes from a `<input type="file">` element.
+     *
+     * @example
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.createBinary(myFile, 'test.jpg', 'image/jpeg');
+     * console.log(result.id);
+     * ```
+     *
+     * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
+     *
+     * @category Create
+     * @param createBinaryOptions -The binary options. See `CreateBinaryOptions` for full details.
+     * @param requestOptions - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     */
+    createBinary(createBinaryOptions: CreateBinaryOptions, requestOptions?: MedplumRequestOptions): Promise<WithId<Binary>>;
+    /**
+     * @category Create
+     * @param data - The binary data to upload.
+     * @param filename - Optional filename for the binary.
+     * @param contentType - Content type for the binary.
+     * @param onProgress - Optional callback for progress events. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @param options - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     * @deprecated Use `createBinary` with `CreateBinaryOptions` instead. To be removed in a future version.
+     */
+    createBinary(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<WithId<Binary>>;
     pushToAgent(agent: Agent | Reference<Agent>, destination: Device | Reference<Device> | string, body: any, contentType?: string, _waitForResponse?: boolean, _options?: MedplumRequestOptions): Promise<any>;
     setAgentAvailable(value: boolean): void;
     getSubscriptionManager(): MockSubscriptionManager;