Class JikeClient

Hierarchy

EventEmitter<EventMap>
- JikeClient

Index

Constructors

constructor

new JikeClient(
    __namedParameters: Partial<ApiConfigResolved> & Pick<
        ApiConfigResolved,
        | "endpointId"
        | "endpointUrl"
        | "bundleId"
        | "appVersion"
        | "buildNo"
        | "userAgent",
    > & { refreshToken?: string },
): 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

`Static`prefixed

prefixed: string | boolean

Accessors

accessToken

get accessToken(): string
Returns string
- Defined in src/client/client.ts:43
set accessToken(token: string): 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;
}
- Defined in src/client/client.ts:60

config

get config(): ApiConfigResolved
Returns ApiConfigResolved
- Defined in src/client/client.ts:53
set config(config: ApiConfigResolved): 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 extends "renewToken">(
    event: T,
    fn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void,
    context?: any,
): this
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- fn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:45

createPost

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

emit

emit<T extends "renewToken">(
event: T,
...args: ArgumentMap<EventMap>[Extract<T, "renewToken">],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- ...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: ApiOptions.PostType, id: string): JikePost
Parameters
- type: ApiOptions.PostType
- id: string
Returns JikePost
- Defined in src/client/client.ts:292
getPost(type: ApiOptions.PostType, id: string, detail: Post): JikePostWithDetail
Parameters
- type: ApiOptions.PostType
- id: string
- detail: Post
Returns JikePostWithDetail
- Defined in src/client/client.ts:293

getSelf

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

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

getUser

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

listenerCount

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

loginWithPassword

loginWithPassword(
    areaCode: string | number,
    mobile: string,
    password: string,
): 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: string | number,
    mobile: string,
    smsCode: string | number,
): 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 extends "renewToken">(
    event: T,
    fn?: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- Optionalfn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:69

on

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

once

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

queryFollowingUpdates

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

queryNotifications

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

removeAllListeners

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

removeListener

removeListener<T extends "renewToken">(
    event: T,
    fn?: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends "renewToken"
Parameters
- event: T
- Optionalfn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
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:306

sendSmsCode

sendSmsCode(areaCode: string | number, mobile: string): Promise<void>
发送短信验证码
Parameters
- areaCode: string | number
  区号，如 +86
- mobile: string
  手机号
Returns Promise<void>
Throws
RequestFailureError 请求失败错误
- Defined in src/client/client.ts:108

serialize

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

toJSON

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

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

`Static`deserialize

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

`Static`fromJSON

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

Class JikeClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns JikeClient

Properties

Staticprefixed

Accessors

accessToken

Returns string

Parameters

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;}

config

Returns ApiConfigResolved

Parameters

Returns void

refreshToken

Returns string

Methods

addListener

Type Parameters

Parameters

Returns this

createPost

Parameters

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

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns "renewToken"[]

getPost

Parameters

Returns JikePost

Parameters

Returns JikePostWithDetail

getSelf

Returns JikeUser<true>

getUser

Type Parameters

Parameters

Returns JikeUser

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void)[]

loginWithPassword

Parameters

Returns Promise<void>

Throws

loginWithSmsCode

Parameters

Returns Promise<void>

Throws

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

queryFollowingUpdates

Parameters

`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;
}

`Static`deserialize

`Static`fromJSON