NewsClient

Client pour les opérations liées aux actualités

Ce Client fournit des méthodes pour interagir avec les endpoints d’actualités de la X API. Il prend en charge l’authentification, le formatage des requêtes et l’analyse des réponses pour toutes les opérations liées aux actualités.

​

Constructeurs

​

constructeur

• new NewsClient(client): NewsClient

Crée une nouvelle instance de NewsClient

​

Paramètres

Nom	Type	Description
client	Client	L’instance principale de Client pour X API

​

Renvoie

NewsClient

​

Défini dans

news/client.ts:96

​

Méthodes

​

get

▸ get(id, options): Promise<Response>

Récupère des articles d’actualité par identifiant Récupère un article d’actualité par son identifiant.

​

Paramètres

Nom	Type	Description
id	string	L’identifiant de l’actualité.
options	GetOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

news/client.ts:141

▸ get(id, options?): Promise<Get2NewsIdResponse>

​

Paramètres

Nom	Type
id	string
options?	GetOptions

​

Retourne

Promise<Get2NewsIdResponse>

​

Défini dans

news/client.ts:154

---

​

search

▸ search(query, options): Promise<Response>

Recherche d’actualités Renvoie une liste d’articles d’actualité correspondant à la requête de recherche spécifiée.

​

Paramètres

Nom	Type	Description
query	string	La requête de recherche.
options	SearchOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

news/client.ts:288

▸ search(query, options?): Promise<Get2NewsSearchResponse>

​

Paramètres

Nom	Type
query	string
options?	SearchOptions

​

Renvoie

Promise<Get2NewsSearchResponse>

​

Définie dans

news/client.ts:301