Client

X API용 기본 Client 클래스

이 클래스는 X API와 상호작용하기 위한 주요 진입점입니다. 전용 Client 모듈을 통해 모든 API 엔드포인트에 대한 접근을 제공하며, 인증, 요청 구성, 오류 처리를 담당합니다.

Example

import { Client } from '@xdevplatform/xdk';

const client = new Client({
  bearerToken: 'your-bearer-token'
});

// 사용자 정보 가져오기
const user = await client.users.getUser('783214');

// 페이지네이션을 사용하여 팔로워 가져오기
const followers = await client.users.getFollowers('783214', {
  maxResults: 10,
  userFields: ['id', 'name', 'username']
});

// 팔로워 반복 처리
for await (const follower of followers) {
  console.log(follower.username);
}

​

생성자

​

constructor

• new Client(config): Client

새로운 X API 클라이언트 인스턴스를 생성합니다

​

매개변수

Name	Type	Description
config	any	Client 구성 옵션

​

반환값

Client

예제

// Bearer 토큰 인증
const client = new Client({
  bearerToken: 'your-bearer-token'
});

// OAuth2 인증
const client = new Client({
  accessToken: 'your-access-token'
});

// OAuth1 인증
const client = new Client({
  oauth1: oauth1Instance
});

client.ts:401

​

속성

baseUrl · string · 필수

API 요청에 사용할 기본 URL

bearerToken · string

인증을 위한 Bearer 토큰

accessToken · string

OAuth2 액세스 토큰

oauth1 · any

인증을 위한 OAuth1 인스턴스

headers · Headers · 필수

요청 헤더

timeout · number · 필수

요청 타임아웃(밀리초 단위)

retry · boolean · 필수

실패한 요청을 자동으로 재시도할지 여부

maxRetries · number · 필수

최대 재시도 횟수

httpClient · HttpClient = httpClient · 필수

요청을 수행하는 HTTP 클라이언트

general · GeneralClient · 필수

general 클라이언트

accountActivity · AccountActivityClient · 필수

account activity 클라이언트

communityNotes · CommunityNotesClient · 필수

community notes 클라이언트

compliance · ComplianceClient · 필수

compliance 클라이언트

connections · ConnectionsClient · 필수

connections 클라이언트

users · UsersClient · 필수

users 클라이언트

news · NewsClient · 필수

news 클라이언트

spaces · SpacesClient · 필수

spaces 클라이언트

activity · ActivityClient · 필수

activity 클라이언트

usage · UsageClient · 필수

usage 클라이언트

trends · TrendsClient · 필수

trends 클라이언트

posts · PostsClient · 필수

게시물 클라이언트

directMessages · DirectMessagesClient · 필수

direct messages 클라이언트

communities · CommunitiesClient · 필수

communities 클라이언트

media · MediaClient · 필수

media 클라이언트

webhooks · WebhooksClient · 필수

webhooks 클라이언트

stream · StreamClient · 필수

stream 클라이언트

lists · ListsClient · 필수

리스트 클라이언트

request · Promise<T> · 필수

인증된 X API 요청을 수행합니다

이 메서드는 모든 API 요청에 대해 인증, 요청 포맷 구성, 오류 처리를 수행합니다. 클라이언트 설정에 따라 적절한 인증 헤더를 자동으로 추가합니다.

isTokenExpired · boolean · 필수

OAuth2 토큰이 만료되었는지 확인합니다

refreshToken · Promise<void> · 필수

OAuth2 토큰을 갱신합니다

isAuthenticated · boolean · 필수

현재 인증 상태를 반환합니다

mapSecuritySchemeToAuthTypes · string[] · 필수

OpenAPI 보안 스키마 이름을 내부 인증 유형에 매핑합니다

validateAuthentication · void · 필수

필요한 인증 방식이 사용 가능한지 검증합니다

getAvailableAuthTypes · string[] · 필수

사용 가능한 인증 유형을 반환합니다