타입

@nodaro/sdk는 대부분의 메서드 입력과 출력에 대한 TypeScript 타입과 함께, 몇 가지 헬퍼 함수와 상수를 내보냅니다. 타입은 import type으로 가져오세요. 그러면 번들에 아무것도 추가되지 않습니다.

import type { Workflow, Job, NodeJobOutput, WorkflowExecution } from "@nodaro/sdk"

const { data }: { data: Workflow } = await client.workflows.get(id)

타입은 API의 전송 형식을 따릅니다. Job은 API가 그렇게 보내기 때문에 output_data, created_at 같은 snake_case 필드를 씁니다. Workflow와 WorkflowExecution은 camelCase를 씁니다. 오브젝트 타입인 Object는 JavaScript 전역 객체와 이름이 같으므로, 둘 다 필요할 때는 다른 이름으로 가져오세요: import type { Object as NodaroObject } from "@nodaro/sdk".

메서드가 쓰는 타입 중 일부는 내보내지 않습니다. PipelineInput이나 CommunityFullDetail처럼 @nodaro/shared에 정의된 타입은 그곳에서 가져옵니다. @nodaro/shared를 SDK가 쓰는 버전 범위로 내 의존성에 추가하면 사본이 하나만 설치됩니다. PipelineRecord 같은 그 밖의 타입은 그 타입을 반환하는 메서드에서 도출하세요.

import type { NodaroClient } from "@nodaro/sdk"
import type { PipelineInput, CommunityFullDetail } from "@nodaro/shared"

type PipelineRecord = Awaited<ReturnType<NodaroClient["pipelines"]["get"]>>

클라이언트, 인증, 오류

워크플로, 실행, 노드

미디어, 보이스, 편집

에셋

프로덕션

계정과 카탈로그

헬퍼 함수와 상수

이것들은 타입이 아니라 값이므로 type 없이 가져오세요.

WorkflowsResource나 NodesResource 같은 모든 리소스 클래스도 고급 타입 지정을 위해 내보냅니다. 이 클래스가 필요한 경우는 드뭅니다. createClient가 모든 리소스를 만들어 주기 때문입니다.