cypress-slack-test/src/index.d.ts

Library that adds commands to Cypress to help navigate trough Slack for end-to-end testing you Slack bots

// Type definitions for cypress-slack-test

declare namespace Cypress {
  interface Chainable<Subject = any> {
    /**
     * Navigates Cypress to the required Slack workspace
     *
     * @example `cy.visitWorkspace('example')` goes to `https://example.slack.com
     *
     * @param workspaceName
     */
    visitWorkspace(workspaceName: string): Chainable<Subject>

    /**
     * When on the login page, using this function will fill and submit the login
     * form with the given params
     *
     * @param username
     * @param password
     */
    login(username: string, password: string): Chainable<Subject>

    /**
     * Finds the channel with the given name and navigate to it
     *
     * @param channelName
     */
    goToChannel(channelName: string | RegExp): Chainable<Subject>

    /**
     * Returns a list of the visible messages of a channel
     */
    getVisibleMessages<K extends keyof HTMLElementTagNameMap>(): Chainable<
      JQuery<HTMLElementTagNameMap[K]>
    >

    /**
     * Send the given message to the current channel
     *
     * @param message
     * @param forceClickSend force the click on the send button @example when there's the command dropdown open
     */
    sendMessage(message: string, forceClickSend?: boolean): Chainable<Subject>
  }
}