Перейти к основному содержимому

unwrap

@mineflow/client-core


@mineflow/client-core / unwrap

Function: unwrap()

function unwrap<T>(result: object): T;

Defined in: packages/client-core/src/errors.ts:151

Извлекает данные из openapi-fetch-совместимого результата { data, error, response }, либо бросает MineflowApiError, если ответ не-OK или присутствует error.

Основная точка входа для работы с ответами клиента: оборачивает каждый вызов client.GET/POST/..., чтобы дальше работать с чистыми данными, а ошибки ловить единым try/catch.

Type Parameters

Type ParameterDescription
Tтип успешных данных эндпоинта (выводится openapi-fetch).

Parameters

ParameterTypeDescription
result{ data?: T; error?: unknown; response: { ok: boolean; status: number; url: string; }; }результат вызова openapi-fetch-метода.
result.data?T-
result.error?unknown-
result.response{ ok: boolean; status: number; url: string; }-
result.response.okboolean-
result.response.statusnumber-
result.response.urlstring-

Returns

T

result.data, если ответ OK.

Throws

MineflowApiError если response.ok === false или задан error.

Example

const page = unwrap(await client.GET('/api/v1/eam/assets', { ... }));