Class JikeClient

Hierarchy

EventEmitter<EventMap>
- JikeClient

Index

Constructors

constructor

new JikeClient(__namedParameters): JikeClient
Parameters
- __namedParameters: Partial<ApiConfigResolved> & Pick<ApiConfigResolved, "endpointId" | "endpointUrl" | "bundleId" | "appVersion" | "buildNo" | "userAgent"> & {
  refreshToken?: string;
  }
Returns JikeClient
Overrides EventEmitter<EventMap>.constructor
- Defined in src/client/client.ts:64

Properties

`Private` #client

#client: {
    comments: api/comments;
    mediaMeta: api/media-meta;
    notifications: api/notifications;
    personalUpdate: api/personal-update;
    posts: api/posts;
    recommendFeed: api/recommend-feed;
    stories: api/stories;
    topics: api/topics;
    upload: api/upload;
    userRelation: api/user-relation;
    users: api/users;
}

Type declaration

comments: api/comments
mediaMeta: api/media-meta
notifications: api/notifications
personalUpdate: api/personal-update
posts: api/posts
recommendFeed: api/recommend-feed
stories: api/stories
topics: api/topics
upload: api/upload
userRelation: api/user-relation
users: api/users

`Private` #config

#config: ApiConfigResolved

`Private` #refreshToken

#refreshToken: string

`Private` #userCache

#userCache: {
[userSelfKey]?: JikeUser<true>;
} & Record<string, JikeUser<boolean>> = {}

Type declaration

Optional [userSelfKey]?: JikeUser<true>

`Static` prefixed

prefixed: string | boolean

Accessors

accessToken

get accessToken(): string
Returns string
- Defined in src/client/client.ts:43
set accessToken(token): void
Parameters
- token: string
Returns void
- Defined in src/client/client.ts:46

apiClient

get apiClient(): {
    comments: api/comments;
    mediaMeta: api/media-meta;
    notifications: api/notifications;
    personalUpdate: api/personal-update;
    posts: api/posts;
    recommendFeed: api/recommend-feed;
    stories: api/stories;
    topics: api/topics;
    upload: api/upload;
    userRelation: api/user-relation;
    users: api/users;
}
Returns {
    comments: api/comments;
    mediaMeta: api/media-meta;
    notifications: api/notifications;
    personalUpdate: api/personal-update;
    posts: api/posts;
    recommendFeed: api/recommend-feed;
    stories: api/stories;
    topics: api/topics;
    upload: api/upload;
    userRelation: api/user-relation;
    users: api/users;
}
- comments: api/comments
- mediaMeta: api/media-meta
- notifications: api/notifications
- personalUpdate: api/personal-update
- posts: api/posts
- recommendFeed: api/recommend-feed
- stories: api/stories
- topics: api/topics
- upload: api/upload
- userRelation: api/user-relation
- users: api/users
- Defined in src/client/client.ts:60

config

get config(): ApiConfigResolved
Returns ApiConfigResolved
- Defined in src/client/client.ts:53
set config(config): void
Parameters
- config: ApiConfigResolved
Returns void
- Defined in src/client/client.ts:56

refreshToken

get refreshToken(): string
Returns string
- Defined in src/client/client.ts:50

Methods

addListener

addListener<T>(event, fn, context?): JikeClient
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]
      
      Returns void
- Optional context: any
Returns JikeClient
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:45

`Private` beforeRetry

beforeRetry(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: BeforeRetryState
Returns Promise<boolean>
- Defined in src/client/client.ts:82

`Private` createClient

createClient(): void
Returns void
- Defined in src/client/client.ts:75

createPost

createPost(type, content, options?): Promise<{
post: JikePostWithDetail;
toast: string;
}>
Parameters
- type: ApiOptions.PostType
  
  动态类型，原帖或转发
- content: string
  
  内容
- Optional options: CreatePostOption
  
  发送动态选项
Returns Promise<{
post: JikePostWithDetail;
toast: string;
}>
- Defined in src/client/client.ts:271

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- Rest ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): "renewToken"[]
Return an array listing the events for which the emitter has registered listeners.

Returns "renewToken"[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:15

getPost

getPost(type, id): JikePost
Parameters
- type: ApiOptions.PostType
- id: string
Returns JikePost
- Defined in src/client/client.ts:286
getPost(type, id, detail): JikePostWithDetail
Parameters
- type: ApiOptions.PostType
- id: string
- detail: Post
Returns JikePostWithDetail
- Defined in src/client/client.ts:287

getSelf

getSelf(): JikeUser<true>
获取自身用户

Returns JikeUser<true>
JikeUser 实例
- Defined in src/client/client.ts:187

getUser

getUser<M>(username): JikeUser<boolean>
获取用户
Type Parameters
- M extends boolean = boolean
  是否为自己
  - true: 是
  - false: 否
  - boolean: 未知（默认）
Parameters
- username: string
  
  用户名
Returns JikeUser<boolean>
JikeUser 实例
- Defined in src/client/client.ts:178

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: "renewToken"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "renewToken"
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:20

loginWithPassword

loginWithPassword(areaCode, mobile, password): Promise<void>
密码登录
Parameters
- areaCode: string | number
  
  区号，如 +86
- mobile: string
  
  手机号
- password: string
  
  密码
Returns Promise<void>

Throws
RequestFailureError 请求失败错误
- Defined in src/client/client.ts:150

loginWithSmsCode

loginWithSmsCode(areaCode, mobile, smsCode): Promise<void>
短信登录
Parameters
- areaCode: string | number
  
  区号，如 +86
- mobile: string
  
  手机号
- smsCode: string | number
  
  短信验证码
Returns Promise<void>

Throws
RequestFailureError 请求失败错误
- Defined in src/client/client.ts:123

off

off<T>(event, fn?, context?, once?): JikeClient
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns JikeClient
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): JikeClient
Add a listener for a given event.
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]
      
      Returns void
- Optional context: any
Returns JikeClient
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): JikeClient
Add a one-time listener for a given event.
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]
      
      Returns void
- Optional context: any
Returns JikeClient
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:54

queryFollowingUpdates

queryFollowingUpdates(option?): Promise<(JikePostWithDetail | {
actionTime: string;
} & PersonalUpdate)[]>
查询关注动态
Parameters
- option: PaginatedOption<FollowingUpdate, "createdAt", undefined | {
      lastPageEarliestTime: number;
      lastReadTime: number;
      session: "PopulatedUpdate";
  }> = {}
Returns Promise<(JikePostWithDetail | {
actionTime: string;
} & PersonalUpdate)[]>
- Defined in src/client/client.ts:224

queryNotifications

queryNotifications(option?): Promise<Notification[]>
查询通知
Parameters
- option: PaginatedOption<Notification, "createdAt" | "updatedAt", string> = {}
Returns Promise<Notification[]>
- Defined in src/client/client.ts:195

removeAllListeners

removeAllListeners(event?): JikeClient
Remove all listeners, or those of the specified event.
Parameters
- Optional event: "renewToken"
Returns JikeClient
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): JikeClient
Remove the listeners of a given event.
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns JikeClient
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:63

renewToken

renewToken(): Promise<void>
刷新 access token

Returns Promise<void>
- Defined in src/client/client.ts:300

sendSmsCode

sendSmsCode(areaCode, mobile): Promise<void>
发送短信验证码
Parameters
- areaCode: string | number
  
  区号，如 +86
- mobile: string
  
  手机号
Returns Promise<void>

Throws
RequestFailureError 请求失败错误
- Defined in src/client/client.ts:108

serialize

serialize(space?): Promise<string>
序列化
Parameters
- space: number = 0
  
  缩进空格数
Returns Promise<string>
- Defined in src/client/client.ts:341

toJSON

toJSON(): Promise<JikeClientJSON>
转换为 JSON 数据

Returns Promise<JikeClientJSON>
- Defined in src/client/client.ts:321

`Static` deserialize

deserialize(data): JikeClient
反序列化
Parameters
- data: string
  
  数据
Returns JikeClient
- Defined in src/client/client.ts:376

`Static` fromJSON

fromJSON(data, config?): JikeClient
从 JSON 数据创建
Parameters
- data: JikeClientJSON
  
  数据
- config: Partial<ApiConfig> = {}
  
  其他配置项
Returns JikeClient
- Defined in src/client/client.ts:350

Class JikeClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: Partial<ApiConfigResolved> & Pick<ApiConfigResolved, "endpointId" | "endpointUrl" | "bundleId" | "appVersion" | "buildNo" | "userAgent"> & { refreshToken?: string; }

Returns JikeClient

Properties

Private #client

Type declaration

comments: api/comments

mediaMeta: api/media-meta

notifications: api/notifications

personalUpdate: api/personal-update

posts: api/posts

recommendFeed: api/recommend-feed

stories: api/stories

topics: api/topics

upload: api/upload

userRelation: api/user-relation

users: api/users

Private #config

Private #refreshToken

Private #userCache

Type declaration

Optional [userSelfKey]?: JikeUser<true>

Static prefixed

Accessors

accessToken

Returns string

Parameters

token: string

Returns void

apiClient

Returns { comments: api/comments; mediaMeta: api/media-meta; notifications: api/notifications; personalUpdate: api/personal-update; posts: api/posts; recommendFeed: api/recommend-feed; stories: api/stories; topics: api/topics; upload: api/upload; userRelation: api/user-relation; users: api/users; }

comments: api/comments

mediaMeta: api/media-meta

notifications: api/notifications

personalUpdate: api/personal-update

posts: api/posts

recommendFeed: api/recommend-feed

stories: api/stories

topics: api/topics

upload: api/upload

userRelation: api/user-relation

users: api/users

config

Returns ApiConfigResolved

Parameters

config: ApiConfigResolved

Returns void

refreshToken

Returns string

Methods

addListener

Type Parameters

T extends "renewToken"

Parameters

event: T

fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]

Returns void

Optional context: any

Returns JikeClient

Private beforeRetry

Parameters

__namedParameters: BeforeRetryState

Returns Promise<boolean>

Private createClient

Returns void

createPost

Parameters

type: ApiOptions.PostType

content: string

__namedParameters: Partial<ApiConfigResolved> & Pick<ApiConfigResolved, "endpointId" | "endpointUrl" | "bundleId" | "appVersion" | "buildNo" | "userAgent"> & {
refreshToken?: string;
}

`Private` #client

`Private` #config

`Private` #refreshToken

`Private` #userCache

`Optional` [userSelfKey]?: JikeUser<true>

`Static` prefixed

Returns {
comments: api/comments;
mediaMeta: api/media-meta;
notifications: api/notifications;
personalUpdate: api/personal-update;
posts: api/posts;
recommendFeed: api/recommend-feed;
stories: api/stories;
topics: api/topics;
upload: api/upload;
userRelation: api/user-relation;
users: api/users;
}

`Rest` ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]

`Optional` context: any

`Private` beforeRetry

`Private` createClient

`Optional` options: CreatePostOption

Returns Promise<{
post: JikePostWithDetail;
toast: string;
}>

`Rest` ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]

`Optional` context: any

`Optional` once: boolean