diff --git a/package.json b/package.json index d4af7128e3580991f03d9d7d7ccd2731db141b19..346737f5d57fde07d839abc6b1c3bee87d9a5d39 100644 --- a/package.json +++ b/package.json @@ -128,7 +128,7 @@ "gl-matrix": "^2.6.1", "glob": "^7.1.0", "jsdoc-to-markdown": "^4.0.0", - "markdownlint-cli": "^0.11.0", + "markdownlint-cli": "^0.12.0", "nyc": "^12.0.1", "qrcode-terminal": "^0.12.0", "request": "^2.87.0", diff --git a/src/user/room.ts b/src/user/room.ts index d912cf060297961b2e531b2e8f127e293e63af01..49f98bb1665e3b770e49db42c7194ae94f664bcd 100644 --- a/src/user/room.ts +++ b/src/user/room.ts @@ -486,7 +486,7 @@ export class Room extends Accessory implements Sayable { * // after logged in... * const room = await bot.Room.find({topic: 'topic of your room'}) // change `event-room` to any room topic in your wechat * if (room) { - * room.on('join', (room: Room, inviteeList: Contact[], inviter: Contact) => { + * room.on('join', (room, inviteeList, inviter) => { * const nameList = inviteeList.map(c => c.name()).join(',') * console.log(`Room got new member ${nameList}, invited by ${inviter}`) * }) @@ -498,7 +498,7 @@ export class Room extends Accessory implements Sayable { * // after logged in... * const room = await bot.Room.find({topic: 'topic of your room'}) // change `event-room` to any room topic in your wechat * if (room) { - * room.on('leave', (room: Room, leaverList: Contact[]) => { + * room.on('leave', (room, leaverList) => { * const nameList = leaverList.map(c => c.name()).join(',') * console.log(`Room lost member ${nameList}`) * }) @@ -510,7 +510,7 @@ export class Room extends Accessory implements Sayable { * // after logged in... * const room = await bot.Room.find({topic: 'topic of your room'}) // change `event-room` to any room topic in your wechat * if (room) { - * room.on('topic', (room: Room, topic: string, oldTopic: string, changer: Contact) => { + * room.on('topic', (room, topic, oldTopic, changer) => { * console.log(`Room topic changed from ${oldTopic} to ${topic} by ${changer.name()}`) * }) * } diff --git a/src/wechaty.ts b/src/wechaty.ts index 285958d92b83bbd279c0f59f5f318ed378c2f4c2..45cfc80cd93fe068857662a68954a4e7aa43cfa4 100644 --- a/src/wechaty.ts +++ b/src/wechaty.ts @@ -380,35 +380,35 @@ export class Wechaty extends Accessory implements Sayable { * @example Event:scan * // Scan Event will emit when the bot needs to show you a QR Code for scanning * - * bot.on('scan', (url: string, code: number) => { + * bot.on('scan', (url, code) => { * console.log(`[${code}] Scan ${url} to login.` ) * }) * * @example Event:login * // Login Event will emit when bot login full successful. * - * bot.on('login', (user: ContactSelf) => { + * bot.on('login', (user) => { * console.log(`user ${user} login`) * }) * * @example Event:logout * // Logout Event will emit when bot detected log out. * - * bot.on('logout', (user: ContactSelf) => { + * bot.on('logout', (user) => { * console.log(`user ${user} logout`) * }) * * @example Event:message * // Message Event will emit when there's a new message. * - * wechaty.on('message', (message: Message) => { + * wechaty.on('message', (message) => { * console.log(`message ${message} received`) * }) * * @example Event:friendship * // Friendship Event will emit when got a new friend request, or friendship is confirmed. * - * bot.on('friendship', (friendship: Friendship) => { + * bot.on('friendship', (friendship) => { * if(friendship.type() === Friendship.Type.RECEIVE){ // 1. receive new friendship request from new contact * const contact = friendship.contact() * let result = await friendship.accept() @@ -425,7 +425,7 @@ export class Wechaty extends Accessory implements Sayable { * @example Event:room-join * // room-join Event will emit when someone join the room. * - * bot.on('room-join', (room: Room, inviteeList: Contact[], inviter: Contact) => { + * bot.on('room-join', (room, inviteeList, inviter) => { * const nameList = inviteeList.map(c => c.name()).join(',') * console.log(`Room ${room.topic()} got new member ${nameList}, invited by ${inviter}`) * }) @@ -433,7 +433,7 @@ export class Wechaty extends Accessory implements Sayable { * @example Event:room-leave * // room-leave Event will emit when someone leave the room. * - * bot.on('room-leave', (room: Room, leaverList: Contact[]) => { + * bot.on('room-leave', (room, leaverList) => { * const nameList = leaverList.map(c => c.name()).join(',') * console.log(`Room ${room.topic()} lost member ${nameList}`) * }) @@ -441,7 +441,7 @@ export class Wechaty extends Accessory implements Sayable { * @example Event:room-topic * // room-topic Event will emit when someone change the room's topic. * - * bot.on('room-topic', (room: Room, topic: string, oldTopic: string, changer: Contact) => { + * bot.on('room-topic', (room, topic, oldTopic, changer) => { * console.log(`Room ${room.topic()} topic changed from ${oldTopic} to ${topic} by ${changer.name()}`) * }) *