Class Article

摸鱼派文章接口

Index

Constructors

constructor

Methods

channel detail follow heat list md post reward setToken thank unfollow unwatch update userArticles vote watch

Constructors

constructor

new Article(token?: string): Article
各个模块的实例化
Parameters
- token: string = ''
  认证 Token
Returns Article
- Defined in article.ts:49

Methods

channel

channel(id: string, type: ArticleType): ArticleChannel
获取文章频道
Parameters
- id: string
  文章 Id
- type: ArticleType
  文章类型
Returns ArticleChannel
文章频道实例
- Defined in article.ts:409

detail

detail(id: string, p?: number): Promise<ArticleDetail>
获取文章详情
Parameters
- id: string
  文章id
- p: number = 1
Returns Promise<ArticleDetail>
文章详情
- Defined in article.ts:187

follow

follow(followingId: string): Promise<void>
收藏文章
Parameters
- followingId: string
  文章id
Returns Promise<void>
- Defined in article.ts:254

heat

heat(id: string): Promise<number>
获取文章在线人数
Parameters
- id: string
  文章id
Returns Promise<number>
文章热度值
- Defined in article.ts:367

list

list(
    params: {
        page?: number;
        size?: number;
        tag?: string;
        type: ArticleListType;
    },
): Promise<ArticleList>
查询文章列表
Parameters
- params: { page?: number; size?: number; tag?: string; type: ArticleListType }
  查询参数
  - Optionalpage?: number
    页码，默认 1
  - Optionalsize?: number
    每页数量，默认 20
  - Optionaltag?: string
    指定查询标签，可选
  - type: ArticleListType
    查询类型
Returns Promise<ArticleList>
文章列表
- Defined in article.ts:124

md

md(articleId: string): Promise<string>
获取帖子的Markdown原文
Parameters
- articleId: string
  文章Id
Returns Promise<string>
文章 Markdown 内容
- Defined in article.ts:388

post

post(data: IArticlePost): Promise<string>
发布文章
Parameters
- data: IArticlePost
  文章信息
Returns Promise<string>
发布成功返回文章Id (articleId)
- Defined in article.ts:69

reward

reward(id: string): Promise<void>
打赏文章
Parameters
- id: string
  文章id
Returns Promise<void>
- Defined in article.ts:345

setToken

setToken(token: string): void
重新设置请求 Token
Parameters
- token: string
  接口 API Key
Returns void
- Defined in article.ts:60

thank

thank(id: string): Promise<void>
感谢文章
Parameters
- id: string
  文章id
Returns Promise<void>
void
- Defined in article.ts:233

unfollow

unfollow(followingId: string): Promise<void>
取消收藏文章
Parameters
- followingId: string
  文章id
Returns Promise<void>
void
- Defined in article.ts:277

unwatch

unwatch(followingId: string): Promise<void>
取消关注文章
Parameters
- followingId: string
  文章id
Returns Promise<void>
void
- Defined in article.ts:323

update

update(id: string, data: IArticlePost): Promise<string>
更新文章
Parameters
- id: string
  文章 Id
- data: IArticlePost
  文章信息
Returns Promise<string>
更新成功返回文章Id (articleId)
- Defined in article.ts:95

userArticles

userArticles(
userName: { page?: number; size?: number; userName: string },
): Promise<ArticleList>
查询用户文章列表
Parameters
- userName: { page?: number; size?: number; userName: string }
  用户名
Returns Promise<ArticleList>
文章列表
- Defined in article.ts:157

vote

vote(id: string, type: "up" | "down"): Promise<VoteType>
点赞/取消点赞文章
Parameters
- id: string
  文章id
- type: "up" | "down"
  点赞类型
Returns Promise<VoteType>
文章点赞状态
- Defined in article.ts:208

watch

watch(followingId: string): Promise<void>
关注文章
Parameters
- followingId: string
  文章id
Returns Promise<void>
void
- Defined in article.ts:300

Class Article

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Article

Methods

channel

Parameters

Returns ArticleChannel

detail

Parameters

Returns Promise<ArticleDetail>

follow

Parameters

Returns Promise<void>

heat

Parameters

Returns Promise<number>

list

Parameters

Optionalpage?: number

Optionalsize?: number

Optionaltag?: string

type: ArticleListType

Returns Promise<ArticleList>

md

Parameters

Returns Promise<string>

post

Parameters

Returns Promise<string>

reward

Parameters

Returns Promise<void>

setToken

Parameters

Returns void

thank

Parameters

Returns Promise<void>

unfollow

Parameters

Returns Promise<void>

unwatch

Parameters

Returns Promise<void>

update

Parameters

Returns Promise<string>

userArticles

Parameters

Returns Promise<ArticleList>

vote

Parameters

Returns Promise<VoteType>

watch

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`page?: number

`Optional`size?: number

`Optional`tag?: string