# FNetwork

> Language fallback: requested `ko-KR`; content is `en-US`.

- Human documentation: [https://docs.univer.ai/ko-KR/reference/facade/network](https://docs.univer.ai/ko-KR/reference/facade/network)

- Agent Markdown: [https://docs.univer.ai/ko-KR/reference/facade/network.md](https://docs.univer.ai/ko-KR/reference/facade/network.md)

- Requested language: `ko-KR`

- Content language: `en-US`

- Documentation version: `1.0.4`

- Source: [facade/network.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/facade/network.mdx)

---

Make HTTP requests through `univerAPI.getNetwork()`. Register the Network plugin and import its Facade entry before using these methods. The response wraps the body, status, and headers; `getSSE` returns an observable stream[^observable-stream].

The following example assumes your application serves a JSON list at `/api/items`:

```ts
const network = univerAPI.getNetwork()
const response = await network.get<{ id: string }[]>('/api/items')
console.log(response.status, response.body)
```

[^observable-stream]: An RxJS Observable can emit multiple values over time, whereas a Promise resolves once. Subscribe to consume the stream and unsubscribe when it is no longer needed; SSE carries server-to-client events over HTTP.

## Access

Access through:

* [`FUniver.getNetwork()`](https://docs.univer.ai/ko-KR/reference/facade/univer.md#getnetwork)

## Setup

Register [`@univerjs/network`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs/network.md) or a preset that includes it. In plugin mode, import `@univerjs/network/facade`. Additional methods below require their listed plugin packages. See [Facade setup](https://docs.univer.ai/ko-KR/guides/sheets/getting-started/facade.md).

## `@univerjs/network`

### `FNetwork.delete`

Send DELETE request to the server.

```typescript
delete<T>(url: string, params?: IRequestParams): Promise<HTTPResponse<T>>
```

**Parameters**

* `url` — Required. The requested URL
* `params` — Optional. Request options, including query parameters, headers, and response type

**Returns**

A promise resolving to the HTTP response with a body of type `T`.

**Types:** [`HTTPResponse`](https://unpkg.com/@univerjs/network/lib/types/services/http/response.d.ts) · [`Promise`](https://unpkg.com/@typescript/typescript-darwin-arm64/lib/lib.es5.d.ts) · [`IRequestParams`](https://unpkg.com/@univerjs/network/lib/types/services/http/http.service.d.ts)

**Package:** [`@univerjs/network`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs/network.md) · [Type definitions](https://unpkg.com/@univerjs/network/lib/types/facade/f-network.d.ts)

### `FNetwork.get`

Send a GET request to the server.

```typescript
get<T>(url: string, params?: IRequestParams): Promise<HTTPResponse<T>>
```

**Parameters**

* `url` — Required. The requested URL.
* `params` — Optional. Request options, including query parameters, headers, and response type.

**Returns**

A promise resolving to the HTTP response with a body of type `T`.

**Types:** [`HTTPResponse`](https://unpkg.com/@univerjs/network/lib/types/services/http/response.d.ts) · [`Promise`](https://unpkg.com/@typescript/typescript-darwin-arm64/lib/lib.es5.d.ts) · [`IRequestParams`](https://unpkg.com/@univerjs/network/lib/types/services/http/http.service.d.ts)

**Package:** [`@univerjs/network`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs/network.md) · [Type definitions](https://unpkg.com/@univerjs/network/lib/types/facade/f-network.d.ts)

### `FNetwork.getSSE`

Request for a stream of server-sent events. Instead of a single response, the server sends a stream of responses,
Univer wraps the stream in an [`Observable`](https://rxjs.dev/guide/observable) which you can call `subscribe` on.

```typescript
getSSE<T>(method: HTTPRequestMethod, url: string, params?: IPostRequestParams): Observable<HTTPEvent<T>>
```

**Parameters**

* `method` — Required. HTTP request method
* `url` — Required. The requested URL
* `params` — Optional. params Request options, including body, query parameters, headers, and response type

**Returns**

An observable of HTTP events with response data of type `T`.

**Types:** [`HTTPEvent`](https://unpkg.com/@univerjs/network/lib/types/services/http/response.d.ts) · [`Observable`](https://unpkg.com/rxjs/dist/types/internal/Observable.d.ts) · [`HTTPRequestMethod`](https://unpkg.com/@univerjs/network/lib/types/services/http/request.d.ts) · [`IPostRequestParams`](https://unpkg.com/@univerjs/network/lib/types/services/http/http.service.d.ts)

**Package:** [`@univerjs/network`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs/network.md) · [Type definitions](https://unpkg.com/@univerjs/network/lib/types/facade/f-network.d.ts)

### `FNetwork.patch`

Send PATCH request to the server.

```typescript
patch<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>
```

**Parameters**

* `url` — Required. The requested URL
* `params` — Optional. Request options, including body, query parameters, headers, and response type

**Returns**

A promise resolving to the HTTP response with a body of type `T`.

**Types:** [`HTTPResponse`](https://unpkg.com/@univerjs/network/lib/types/services/http/response.d.ts) · [`Promise`](https://unpkg.com/@typescript/typescript-darwin-arm64/lib/lib.es5.d.ts) · [`IPostRequestParams`](https://unpkg.com/@univerjs/network/lib/types/services/http/http.service.d.ts)

**Package:** [`@univerjs/network`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs/network.md) · [Type definitions](https://unpkg.com/@univerjs/network/lib/types/facade/f-network.d.ts)

### `FNetwork.post`

Send a POST request to the server.

```typescript
post<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>
```

**Parameters**

* `url` — Required. The requested URL.
* `params` — Optional. Request options, including body, query parameters, headers, and response type.

**Returns**

A promise resolving to the HTTP response with a body of type `T`.

**Types:** [`HTTPResponse`](https://unpkg.com/@univerjs/network/lib/types/services/http/response.d.ts) · [`Promise`](https://unpkg.com/@typescript/typescript-darwin-arm64/lib/lib.es5.d.ts) · [`IPostRequestParams`](https://unpkg.com/@univerjs/network/lib/types/services/http/http.service.d.ts)

**Package:** [`@univerjs/network`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs/network.md) · [Type definitions](https://unpkg.com/@univerjs/network/lib/types/facade/f-network.d.ts)

### `FNetwork.put`

Send a PUT request to the server.

```typescript
put<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>
```

**Parameters**

* `url` — Required. The requested URL
* `params` — Optional. Request options, including body, query parameters, headers, and response type

**Returns**

A promise resolving to the HTTP response with a body of type `T`.

**Types:** [`HTTPResponse`](https://unpkg.com/@univerjs/network/lib/types/services/http/response.d.ts) · [`Promise`](https://unpkg.com/@typescript/typescript-darwin-arm64/lib/lib.es5.d.ts) · [`IPostRequestParams`](https://unpkg.com/@univerjs/network/lib/types/services/http/http.service.d.ts)

**Package:** [`@univerjs/network`](https://docs.univer.ai/ko-KR/reference/packages/plugins/univerjs/network.md) · [Type definitions](https://unpkg.com/@univerjs/network/lib/types/facade/f-network.d.ts)