Class ArticleApi

Hierarchy

AuthenticatedRequester
- ArticleApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ArticleApi(apiKey: string, serialize?: boolean): ArticleApi

- Defined in AuthenticatedRequester/AuthenticatedRequester.ts:8
Parameters
- apiKey: string
- serialize: boolean = true
Returns ArticleApi

Properties

Protected Readonly apiKey

apiKey: string

Protected Readonly serialize

serialize: boolean = true

Methods

get

get<QueryParams, Return>(route: string, query: QueryParams, serializer?: responseSerializer<Return>): Promise<Return>

- Defined in AuthenticatedRequester/AuthenticatedRequester.ts:16
Type parameters
- QueryParams
- Return
Parameters
- route: string
- query: QueryParams
- Optional serializer: responseSerializer<Return>
Returns Promise<Return>

getArticleById

getArticleById(id: string): Promise<Article>

- Defined in ArticleApi/ArticleApi.ts:7
Parameters
- id: string
Returns Promise<Article>

getArticleByPath

getArticleByPath(username: string, slug: string): Promise<Article>

- Defined in ArticleApi/ArticleApi.ts:23
Parameters
- username: string
- slug: string
Returns Promise<Article>

getUserPublishedArticle

getUserPublishedArticle(page?: number, per_page?: number): Promise<Article[]>

- Defined in ArticleApi/ArticleApi.ts:15
Parameters
- page: number = 1
- per_page: number = 30
Returns Promise<Article[]>

request

request(url: string, body?: string, method?: string): Promise<any>

- Defined in AuthenticatedRequester/AuthenticatedRequester.ts:25
Parameters
- url: string
- Optional body: string
- method: string = 'get'
Returns Promise<any>

Static serializeArticle

serializeArticle(data: any): Article

- Defined in ArticleApi/ArticleApi.ts:35
Parameters
- data: any
Returns Article

Static serializeArticles

serializeArticles(data: any[]): Article[]

- Defined in ArticleApi/ArticleApi.ts:31
Parameters
- data: any[]
Returns Article[]

Generated using TypeDoc