Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(axe.d.ts): add typings for preload options object #4543

Merged
merged 1 commit into from
Jul 30, 2024

Conversation

blutorange
Copy link
Contributor

Adds the TypeScript typings for passing an object to the preload setting for axe.run, as documented here: https://www.deque.com/axe/core-documentation/api-documentation/#preload-configuration-details

Specifying an object

axe.run(
  {
    preload: { assets: ['cssom'], timeout: 50000 }
  },
  (err, results) => {
    // ...
  }
);

@blutorange blutorange requested a review from a team as a code owner July 23, 2024 11:50
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

@straker straker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update.

Reviewed for security.

@straker
Copy link
Contributor

straker commented Jul 25, 2024

@blutorange You'll need to sign the CLA before we can get this merged.

@straker straker changed the title Add TypeScript typings for preload options object fix(axe.d.ts): add typings for preload options object Jul 25, 2024
@blutorange
Copy link
Contributor Author

blutorange commented Jul 26, 2024

@straker I already did that when I created the commit, but it somehow does not seem to recognize it... strange

image

image

@straker
Copy link
Contributor

straker commented Jul 30, 2024

Looks like the CLA github action isn't working at the moment? I looked at the CLA dashboard on our end and you have indeed signed it, so I'll go ahead and merge this.

screenshot of the CLA dashboard showing user blutorange signed the CLA on Jul 23, 2024 at 5:53:04 AM

@straker straker merged commit cfd2974 into dequelabs:develop Jul 30, 2024
18 of 22 checks passed
straker pushed a commit that referenced this pull request Oct 16, 2024
Adds the TypeScript typings for passing an object to the `preload`
setting for `axe.run`, as documented here:
https://www.deque.com/axe/core-documentation/api-documentation/#preload-configuration-details

> Specifying an object


```js
axe.run(
  {
    preload: { assets: ['cssom'], timeout: 50000 }
  },
  (err, results) => {
    // ...
  }
);
 ```

Co-authored-by: Andre Wachsmuth <[email protected]>
@straker straker mentioned this pull request Oct 16, 2024
WilcoFiers added a commit that referenced this pull request Oct 16, 2024
###
[4.10.1](v4.10.0...v4.10.1)
(2024-10-16)

### Bug Fixes

- **aria-allowed-role:** add form to allowed roles of form element
([#4588](#4588))
([d462d67](d462d67)),
closes
[/github.com/dequelabs/axe-core/blob/develop/lib/standards/html-elms.js#L264](https://github.com/dequelabs//github.com/dequelabs/axe-core/blob/develop/lib/standards/html-elms.js/issues/L264)
- **axe.d.ts:** add typings for preload options object
([#4543](#4543))
([72e269f](72e269f))
- **button-name,input-button-name,input-img-alt:** allow label to give
accessible name
([#4607](#4607))
([364eb72](364eb72)),
closes [#4472](#4472)
[#3696](#3696)
[#3696](#3696)
- **get-ancestry:** add nth-child selector for multiple siblings of
shadow root ([#4606](#4606))
([bdd94a2](bdd94a2)),
closes [#4563](#4563)
- **rules:** Change "alternate text" to "alternative text"
([#4582](#4582))
([31e0f61](31e0f61))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants