[ { "path": ".gitattributes", "content": "# Enforce Unix newlines\n* text=auto eol=lf\n\nbenchmark/documents/* binary\nbenchmark/jquery*.js binary\n" }, { "path": ".github/FUNDING.yml", "content": "github: [cheeriojs, fb55]\nopen_collective: cheerio\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: npm\n directory: '/'\n schedule:\n interval: daily\n open-pull-requests-limit: 10\n versioning-strategy: increase\n - package-ecosystem: npm\n directory: '/website'\n schedule:\n interval: daily\n open-pull-requests-limit: 4\n versioning-strategy: increase\n - package-ecosystem: 'github-actions'\n directory: '/'\n schedule:\n interval: daily\n" }, { "path": ".github/issue_template.md", "content": "\n" }, { "path": ".github/workflows/benchmark.yml", "content": "name: Benchmark\n\non:\n push:\n branches-ignore:\n - 'dependabot/**'\n pull_request:\n\nenv:\n FORCE_COLOR: 2\n\npermissions:\n contents: read\n\njobs:\n benchmark:\n runs-on: ubuntu-latest\n if:\n \"!contains(github.event.commits[0].message, '[bench skip]') &&\n !contains(github.event.commits[0].message, '[skip bench]')\"\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v6\n\n - name: Set up Node.js\n uses: actions/setup-node@v6.3.0\n with:\n node-version: lts/*\n cache: 'npm'\n\n - name: Install npm dependencies\n run: npm ci\n\n - name: Run benchmarks\n run: npm run benchmark\n env:\n BENCHMARK: true\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\non:\n push:\n branches-ignore:\n - 'dependabot/**'\n pull_request:\n\nenv:\n FORCE_COLOR: 2\n NODE_COV: lts/* # The Node.js version to run coveralls on\n\npermissions:\n contents: read\n\njobs:\n run:\n permissions:\n checks: write # for coverallsapp/github-action to create new checks\n contents: read # for actions/checkout to fetch code\n name: Node ${{ matrix.node }}\n runs-on: ubuntu-latest\n\n strategy:\n fail-fast: false\n matrix:\n node:\n - 20\n - 22\n - 24\n - lts/*\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v6\n\n - name: Set up Node.js\n uses: actions/setup-node@v6.3.0\n with:\n node-version: '${{ matrix.node }}'\n cache: 'npm'\n\n - name: Install npm dependencies\n run: npm ci\n\n - name: Run tests\n run: npm run test:vi\n if: matrix.node != env.NODE_COV\n\n - name: Run tests with coverage\n run: npm run test:vi -- --coverage\n if: matrix.node == env.NODE_COV\n\n - name: Run Coveralls\n uses: coverallsapp/github-action@v2.3.7\n if: matrix.node == env.NODE_COV\n continue-on-error: true\n with:\n github-token: '${{ secrets.GITHUB_TOKEN }}'\n" }, { "path": ".github/workflows/codeql.yml", "content": "name: 'CodeQL'\n\non:\n push:\n branches:\n - main\n - '!dependabot/**'\n pull_request:\n # The branches below must be a subset of the branches above\n branches:\n - main\n - '!dependabot/**'\n schedule:\n - cron: '0 0 * * 0'\n\njobs:\n analyze:\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n security-events: write\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v4\n with:\n languages: 'javascript'\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v4\n" }, { "path": ".github/workflows/dependabot-automerge.yml", "content": "# Based on https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions#enable-auto-merge-on-a-pull-request\nname: Dependabot auto-merge\non: pull_request_target\n\npermissions:\n pull-requests: write\n contents: write\n\njobs:\n dependabot:\n runs-on: ubuntu-latest\n if: ${{ github.actor == 'dependabot[bot]' }}\n steps:\n - name: Dependabot metadata\n id: metadata\n uses: dependabot/fetch-metadata@v2.5.0\n with:\n github-token: '${{ secrets.GITHUB_TOKEN }}'\n - name: Enable auto-merge for Dependabot PRs\n # Automatically merge semver-patch and semver-minor PRs\n if:\n \"${{ steps.metadata.outputs.update-type ==\n 'version-update:semver-minor' || steps.metadata.outputs.update-type ==\n 'version-update:semver-patch' }}\"\n run: gh pr merge --auto --squash \"$PR_URL\"\n env:\n PR_URL: ${{github.event.pull_request.html_url}}\n GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}\n" }, { "path": ".github/workflows/lint.yml", "content": "name: Lint\n\non:\n push:\n branches-ignore:\n - 'dependabot/**'\n pull_request:\n\nenv:\n FORCE_COLOR: 2\n\npermissions:\n contents: read\n\njobs:\n lint:\n runs-on: ubuntu-latest\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v6\n\n - name: Set up Node.js\n uses: actions/setup-node@v6.3.0\n with:\n node-version: lts/*\n cache: 'npm'\n\n - name: Install npm dependencies\n run: npm ci\n\n - name: Install website npm dependencies\n run: npm ci\n working-directory: website\n\n - name: Build Cheerio\n run: npm run build\n\n - name: Undo changes to package.json\n run: git restore package.json\n\n - name: Build website\n run: npm run build\n working-directory: website\n\n - name: Run lint\n run: npm run lint\n" }, { "path": ".github/workflows/site.yml", "content": "name: Deploy website to GitHub Pages\n\n# Based on https://raw.githubusercontent.com/actions/starter-workflows\n\non:\n # Runs on pushes targeting the main branch\n push:\n branches: [main]\n\n # Allows you to run this workflow manually from the Actions tab\n workflow_dispatch:\n\nenv:\n FORCE_COLOR: 2\n\n# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages\npermissions:\n contents: read\n pages: write\n id-token: write\n\n# Allow one concurrent deployment\nconcurrency:\n group: 'pages'\n cancel-in-progress: true\n\njobs:\n # Build job\n build:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n - name: Setup Node\n uses: actions/setup-node@v6.3.0\n with:\n # Use current Node LTS version\n node-version: lts/*\n cache: 'npm'\n - name: Setup Pages\n id: pages\n uses: actions/configure-pages@v5\n - name: Install dependencies\n run: npm ci\n - name: Build\n run: npm run build\n - name: Install website dependencies\n working-directory: website\n run: npm ci\n - name: Build docs\n working-directory: website\n run: npm run build\n - name: Upload artifact\n uses: actions/upload-pages-artifact@v4\n with:\n path: ./website/dist\n\n # Deployment job\n deploy:\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n runs-on: ubuntu-latest\n needs: build\n if: ${{github.repository == 'cheeriojs/cheerio'}}\n steps:\n - name: Deploy to GitHub Pages\n id: deployment\n uses: actions/deploy-pages@v4\n" }, { "path": ".github/workflows/sponsors.yml", "content": "name: Update Sponsors\n\non:\n schedule:\n # Run once a day, at 4pm\n - cron: '0 16 * * *'\n # Allow manual trigger\n workflow_dispatch:\n\nenv:\n FORCE_COLOR: 2\n\npermissions:\n contents: read\n\njobs:\n fetch:\n permissions:\n contents: write # for peter-evans/create-pull-request to create branch\n pull-requests: write # for peter-evans/create-pull-request to create a PR\n runs-on: ubuntu-latest\n\n steps:\n - name: Clone repository\n uses: actions/checkout@v6\n\n - name: Set up Node.js\n uses: actions/setup-node@v6.3.0\n with:\n node-version: lts/*\n cache: 'npm'\n\n - name: Install npm dependencies\n run: npm ci\n\n - name: Update the README\n run: npm run update-sponsors\n env:\n CHEERIO_SPONSORS_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n IMGIX_TOKEN: ${{ secrets.IMGIX_TOKEN }}\n\n - name: Create Pull Request\n uses: peter-evans/create-pull-request@v8\n continue-on-error: true\n with:\n commit-message: 'docs(readme): Update Sponsors'\n title: Update Sponsors\n branch: docs/sponsors\n delete-branch: true\n" }, { "path": ".gitignore", "content": "node_modules\nnpm-debug.log\n.DS_Store\n.docusaurus\n.cache-loader\n/coverage\n/.tshy\n/.tshy-build\n/dist\n\n# Website build artifacts\nwebsite/.astro/\nwebsite/dist/\nwebsite/src/content/docs/api\n" }, { "path": ".husky/.gitignore", "content": "_\n" }, { "path": ".husky/pre-commit", "content": "lint-staged" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to Cheerio\n\nThanks for your interest in contributing to the project! Here's a rundown of how\nwe'd like to work with you:\n\n1. File an issue on GitHub describing the contribution you'd like to make. This\n will help us to get you started on the right foot.\n2. Fork the project, and make your changes in a new branch based off of the\n `main` branch:\n 1. Follow the project's code style (see below)\n 2. Add enough unit tests to \"prove\" that your patch is correct\n 3. Update the project documentation as needed (see below)\n 4. Describe your approach with as much detail as necessary in the git\n commit message\n3. Open a pull request, and reference the initial issue in the pull request\n message.\n\n# Documentation\n\nAny API change should be reflected in the project's README.md file. Reuse\n[jQuery's documentation](https://api.jquery.com) wherever possible, but take\ncare to note aspects that make Cheerio distinct.\n\n# Code Style\n\nPlease make sure commit hooks are run, which will enforce the code style.\n\nWhen implementing private functionality that isn't part of the jQuery API,\nplease opt for:\n\n- _Static methods_: If the functionality does not require a reference to a\n Cheerio instance, simply define a named function within the module it is\n needed.\n- _Instance methods_: If the functionality requires a reference to a Cheerio\n instance, informally define the method as \"private\" using the following\n conventions:\n - Define the method as a function on the Cheerio prototype\n - Prefix the method name with an underscore (`_`) character\n - Include `@api private` in the code comment the documents the method\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2022 The Cheerio contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "Readme.md", "content": "

cheerio

\n\n
The fast, flexible, and elegant library for parsing and manipulating HTML and XML.
\n\n
\n \n \"Build\n \n \n \"Coverage\"\n \n \n \"OpenCollective\n \n \n \"OpenCollective\n \n
\n\n
\n\n[中文文档 (Chinese Readme)](https://github.com/cheeriojs/cheerio/wiki/Chinese-README)\n\n```js\nimport * as cheerio from 'cheerio';\nconst $ = cheerio.load('

Hello world

');\n\n$('h2.title').text('Hello there!');\n$('h2').addClass('welcome');\n\n$.html();\n//=>

Hello there!

\n```\n\n## Installation\n\nInstall Cheerio using a package manager like npm, yarn, or bun.\n\n```bash\nnpm install cheerio\n# or\nbun add cheerio\n```\n\n## Features\n\n**❤ Proven syntax:** Cheerio implements a subset of core jQuery. Cheerio\nremoves all the DOM inconsistencies and browser cruft from the jQuery library,\nrevealing its truly gorgeous API.\n\n**ϟ Blazingly fast:** Cheerio works with a very simple, consistent DOM\nmodel. As a result parsing, manipulating, and rendering are incredibly\nefficient.\n\n**❁ Incredibly flexible:** Cheerio wraps around\n[parse5](https://github.com/inikulin/parse5) for parsing HTML and can optionally\nuse the forgiving [htmlparser2](https://github.com/fb55/htmlparser2/). Cheerio\ncan parse nearly any HTML or XML document. Cheerio works in both browser and\nserver environments.\n\n## API\n\n### Loading\n\nFirst you need to load in the HTML. This step in jQuery is implicit, since\njQuery operates on the one, baked-in DOM. With Cheerio, we need to pass in the\nHTML document.\n\n```js\n// ESM or TypeScript:\nimport * as cheerio from 'cheerio';\n\n// In other environments:\nconst cheerio = require('cheerio');\n\nconst $ = cheerio.load('');\n\n$.html();\n//=> \n```\n\n### Selectors\n\nOnce you've loaded the HTML, you can use jQuery-style selectors to find elements\nwithin the document.\n\n#### \\$( selector, [context], [root] )\n\n`selector` searches within the `context` scope which searches within the `root`\nscope. `selector` and `context` can be a string expression, DOM Element, array\nof DOM elements, or cheerio object. `root`, if provided, is typically the HTML\ndocument string.\n\nThis selector method is the starting point for traversing and manipulating the\ndocument. Like in jQuery, it's the primary method for selecting elements in the\ndocument.\n\n```js\n$('.apple', '#fruits').text();\n//=> Apple\n\n$('ul .pear').attr('class');\n//=> pear\n\n$('li[class=orange]').html();\n//=> Orange\n```\n\n### Rendering\n\nWhen you're ready to render the document, you can call the `html` method on the\n\"root\" selection:\n\n```js\n$.root().html();\n//=> \n// \n// \n// \n// \n// \n```\n\nIf you want to render the\n[`outerHTML`](https://developer.mozilla.org/en-US/docs/Web/API/Element/outerHTML)\nof a selection, you can use the `outerHTML` prop:\n\n```js\n$('.pear').prop('outerHTML');\n//=>
  • Pear
    • \n```\n\nYou may also render the text content of a Cheerio object using the `text`\nmethod:\n\n```js\nconst $ = cheerio.load('This is content.');\n$('body').text();\n//=> This is content.\n```\n\n### The \"DOM Node\" object\n\nCheerio collections are made up of objects that bear some resemblance to\n[browser-based DOM nodes](https://developer.mozilla.org/en-US/docs/Web/API/Node).\nYou can expect them to define the following properties:\n\n- `tagName`\n- `parentNode`\n- `previousSibling`\n- `nextSibling`\n- `nodeValue`\n- `firstChild`\n- `childNodes`\n- `lastChild`\n\n## Screencasts\n\n[https://vimeo.com/31950192](https://vimeo.com/31950192)\n\n> This video tutorial is a follow-up to Nettut's \"How to Scrape Web Pages with\n> Node.js and jQuery\", using cheerio instead of JSDOM + jQuery. This video shows\n> how easy it is to use cheerio and how much faster cheerio is than JSDOM +\n> jQuery.\n\n## Cheerio in the real world\n\nAre you using cheerio in production? Add it to the\n[wiki](https://github.com/cheeriojs/cheerio/wiki/Cheerio-in-Production)!\n\n## Sponsors\n\nDoes your company use Cheerio in production? Please consider\n[sponsoring this project](https://github.com/cheeriojs/cheerio?sponsor=1)! Your\nhelp will allow maintainers to dedicate more time and resources to its\ndevelopment and support.\n\n**Headlining Sponsors**\n\n\n\n\n \"Github\"\n \n\n \"AirBnB\"\n \n\n \"HasData\"\n \n\n \"brand.dev\"\n \n\n\n\n**Other Sponsors**\n\n\n\n\n \"OnlineCasinosSpelen\"\n \n\n \"Nieuwe-Casinos.net\"\n \n\n\n\n## Backers\n\n[Become a backer](https://github.com/cheeriojs/cheerio?sponsor=1) to show your\nsupport for Cheerio and help us maintain and improve this open source project.\n\n\n\n\n \"Vasy\n \n\n\n\n## License\n\nMIT\n" }, { "path": "SECURITY.md", "content": "# Security Policy\n\n## Supported Versions\n\nOnly the latest release will receive security updates.\n\n## Reporting a Vulnerability\n\nTo report a security vulnerability, please use the\n[Tidelift security contact](https://tidelift.com/security). Tidelift will\ncoordinate the fix and disclosure.\n" }, { "path": "benchmark/benchmark.ts", "content": "import fs from 'node:fs/promises';\nimport { Script } from 'node:vm';\nimport type { Element } from 'domhandler';\nimport { JSDOM } from 'jsdom';\nimport { Bench } from 'tinybench';\nimport type { Cheerio } from '../src/cheerio.js';\nimport type { CheerioAPI } from '../src/load.js';\nimport { load } from '../src/load-parse.js';\n\nconst documentDir = new URL('documents/', import.meta.url);\nconst jQuerySrc = await fs.readFile(\n new URL('../node_modules/jquery/dist/jquery.slim.js', import.meta.url),\n 'utf8',\n);\nconst jQueryScript = new Script(jQuerySrc);\nconst filterIndex = process.argv.indexOf('--filter') + 1;\nconst benchmarkFilter = filterIndex > 0 ? process.argv[filterIndex] : '';\n\nconst cheerioOnly = process.argv.includes('--cheerio-only');\n\ntype SuiteOptions = T extends void\n ? {\n test(this: void, $: CheerioAPI): void;\n setup?: (this: void, $: CheerioAPI) => T;\n }\n : {\n test(this: void, $: CheerioAPI, data: T): void;\n setup(this: void, $: CheerioAPI): T;\n };\n\nasync function benchmark(\n name: string,\n fileName: string,\n options: SuiteOptions,\n): Promise {\n if (!name.includes(benchmarkFilter)) {\n return;\n }\n const markup = await fs.readFile(new URL(fileName, documentDir), 'utf8');\n\n console.log(`Test: ${name} (file: ${fileName})`);\n\n const bench = new Bench();\n const { test, setup } = options;\n\n // Add Cheerio test\n const $ = load(markup);\n const setupData = setup?.($) as T;\n\n bench.add('cheerio', () => {\n test($, setupData);\n });\n\n // Add JSDOM test\n if (!cheerioOnly) {\n const dom = new JSDOM(markup, { runScripts: 'outside-only' });\n\n jQueryScript.runInContext(dom.getInternalVMContext());\n\n const setupData = setup?.(dom.window['$'] as CheerioAPI) as T;\n\n bench.add('jsdom', () => test(dom.window['$'] as CheerioAPI, setupData));\n }\n\n await bench.run();\n\n console.table(bench.table());\n}\n\nawait benchmark('Select all', 'jquery.html', {\n test: ($) => $('*').length,\n});\nawait benchmark('Select some', 'jquery.html', {\n test: ($) => $('li').length,\n});\n\n/*\n * Manipulation Tests\n */\nconst DIVS_MARKUP = '
    '.repeat(50);\nawait benchmark>('manipulation - append', 'jquery.html', {\n setup: ($) => $('body'),\n test: (_, $body) => $body.append(DIVS_MARKUP),\n});\n\n// JSDOM used to run out of memory on these tests\nawait benchmark>(\n 'manipulation - prepend - highmem',\n 'jquery.html',\n {\n setup: ($) => $('body'),\n test: (_, $body) => $body.prepend(DIVS_MARKUP),\n },\n);\nawait benchmark>(\n 'manipulation - after - highmem',\n 'jquery.html',\n {\n setup: ($) => $('body'),\n test: (_, $body) => $body.after(DIVS_MARKUP),\n },\n);\nawait benchmark>(\n 'manipulation - before - highmem',\n 'jquery.html',\n {\n setup: ($) => $('body'),\n test: (_, $body) => $body.before(DIVS_MARKUP),\n },\n);\n\nawait benchmark>('manipulation - remove', 'jquery.html', {\n setup: ($) => $('body'),\n test($, $lis) {\n const child = $('
    ');\n $lis.append(child);\n child.remove();\n },\n});\n\nawait benchmark('manipulation - replaceWith', 'jquery.html', {\n setup($) {\n $('body').append('
    ');\n },\n test($) {\n $('#foo').replaceWith('
    ');\n },\n});\n\nawait benchmark>('manipulation - empty', 'jquery.html', {\n setup: ($) => $('li'),\n test(_, $lis) {\n $lis.empty();\n },\n});\nawait benchmark>('manipulation - html', 'jquery.html', {\n setup: ($) => $('li'),\n test(_, $lis) {\n $lis.html();\n $lis.html('foo');\n },\n});\nawait benchmark>('manipulation - html render', 'jquery.html', {\n setup: ($) => $('body'),\n test(_, $lis) {\n $lis.html();\n },\n});\n\nconst HTML_INDEPENDENT_MARKUP =\n '
    bat
    baz
    '.repeat(6);\nawait benchmark('manipulation - html independent', 'jquery.html', {\n test: ($) => $(HTML_INDEPENDENT_MARKUP).html(),\n});\nawait benchmark>('manipulation - text', 'jquery.html', {\n setup: ($) => $('li'),\n test(_, $lis) {\n $lis.text();\n $lis.text('foo');\n },\n});\n\n/*\n * Traversing Tests\n */\nawait benchmark>('traversing - Find', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.find('li').length,\n});\nawait benchmark>('traversing - Parent', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.parent('div').length,\n});\nawait benchmark>('traversing - Parents', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.parents('div').length,\n});\nawait benchmark>('traversing - Closest', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.closest('div').length,\n});\nawait benchmark>('traversing - next', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.next().length,\n});\nawait benchmark>('traversing - nextAll', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.nextAll('li').length,\n});\nawait benchmark>('traversing - nextUntil', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.nextUntil('li').length,\n});\nawait benchmark>('traversing - prev', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.prev().length,\n});\nawait benchmark>('traversing - prevAll', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.prevAll('li').length,\n});\nawait benchmark>('traversing - prevUntil', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.prevUntil('li').length,\n});\nawait benchmark>('traversing - siblings', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.siblings('li').length,\n});\nawait benchmark>('traversing - Children', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.children('a').length,\n});\nawait benchmark>('traversing - Filter', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.filter('li').length,\n});\nawait benchmark>('traversing - First', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.first().first().length,\n});\nawait benchmark>('traversing - Last', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.last().last().length,\n});\nawait benchmark>('traversing - Eq', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.eq(0).eq(0).length,\n});\n\n/*\n * Attributes Tests\n */\nawait benchmark>('attributes - Attributes', 'jquery.html', {\n setup: ($) => $('li'),\n test(_, $lis) {\n $lis.attr('foo', 'bar');\n $lis.attr('foo');\n $lis.removeAttr('foo');\n },\n});\nawait benchmark>(\n 'attributes - Single Attribute',\n 'jquery.html',\n {\n setup: ($) => $('body'),\n test(_, $lis) {\n $lis.attr('foo', 'bar');\n $lis.attr('foo');\n $lis.removeAttr('foo');\n },\n },\n);\nawait benchmark>('attributes - Data', 'jquery.html', {\n setup: ($) => $('li'),\n test(_, $lis) {\n $lis.data('foo', 'bar');\n $lis.data('foo');\n },\n});\nawait benchmark>('attributes - Val', 'jquery.html', {\n setup: ($) => $('select,input,textarea,option'),\n test($, $lis) {\n $lis.each(function () {\n $(this).val();\n $(this).val('foo');\n });\n },\n});\n\nawait benchmark>('attributes - Has class', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.hasClass('foo'),\n});\nawait benchmark>('attributes - Toggle class', 'jquery.html', {\n setup: ($) => $('li'),\n test: (_, $lis) => $lis.toggleClass('foo'),\n});\nawait benchmark>(\n 'attributes - Add Remove class',\n 'jquery.html',\n {\n setup: ($) => $('li'),\n test(_, $lis) {\n $lis.addClass('foo');\n $lis.removeClass('foo');\n },\n },\n);\n" }, { "path": "benchmark/documents/jquery.html", "content": "\n \n \n \n \n\n jQuery() | jQuery API Documentation\n\n \n \n\n \n\n \n\n \n \n \n \n\n \n \n\n \n \n \n\n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
    \n
    \n \n
    \n
    \n\n
    \n
    \n

    \n jQuery API Documentation\n

    \n\n \n
    \n\n \n\n
    \n
    \n
    \n \n
    \n

    jQuery()

    \n
    \n
    \n Categories:\n Core\n
    \n \n
    \n \n\n
    \n Return a collection of matched elements either found in the DOM\n based on passed argument(s) or created by passing an HTML\n string.\n
    \n

    Contents:

    \n     \n
    \n
    \n

    \n jQuery( selector [, context ] )Returns:\n jQuery\n

    \n
    \n

    \n Description: Accepts a string containing\n a CSS selector which is then used to match a set of\n elements.\n

    \n     \n
    \n

    \n In the first formulation listed above,\n jQuery() — which can also be written as\n $() — searches through the DOM for any\n elements that match the provided selector and creates a\n new jQuery object that references these elements:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $( \"div.foo\" );
    \n
    \n
    \n\n

    \n If no elements match the provided selector, the new\n jQuery object is \"empty\"; that is, it contains no\n elements and has\n .length\n property of 0.\n

    \n

    \n Selector Context\n

    \n

    \n By default, selectors perform their searches within the\n DOM starting at the document root. However, an alternate\n context can be given for the search by using the\n optional second parameter to the\n $() function. For example, to do a search\n within an event handler, the search can be restricted\n like so:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n     		\n 
    $( \"div.foo\" ).click(function() {
      $( \"span\", this ).addClass( \"bar\" );
    });
    \n
    \n
    \n\n

    \n When the search for the span selector is restricted to\n the context of this, only spans within the\n clicked element will get the additional class.\n

    \n

    \n Internally, selector context is implemented with the\n .find() method, so\n $( \"span\", this )\n is equivalent to\n $( this ).find( \"span\" ).\n

    \n\n

    \n Using DOM elements\n

    \n

    \n The second and third formulations of this function\n create a jQuery object using one or more DOM elements\n that were already selected in some other way.\n

    \n

    \n Note: These formulations are meant to\n consume only DOM elements; feeding mixed data to the\n elementArray form is particularly discouraged.\n

    \n

    \n A common use of this facility is to call jQuery methods\n on an element that has been passed to a callback\n function through the keyword this:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n     		\n 
    $( \"div.foo\" ).click(function() {
      $( this ).slideUp();
    });
    \n
    \n
    \n\n

    \n This example causes elements to be hidden with a sliding\n animation when clicked. Because the handler receives the\n clicked item in the\n this keyword as a bare DOM element, the\n element must be passed to the $() function\n before applying jQuery methods to it.\n

    \n

    \n XML data returned from an Ajax call can be passed to the\n $() function so individual elements of the\n XML structure can be retrieved using\n .find() and other DOM traversal methods.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n     		\n 
    $.post( \"url.xml\", function( data ) {
      var $child = $( data ).find( \"child\" );
    });
    \n
    \n
    \n\n

    \n Cloning jQuery Objects\n

    \n

    \n When a jQuery object is passed to the\n $() function, a clone of the object is\n created. This new jQuery object references the same DOM\n elements as the initial one.\n

    \n\n

    \n Returning an Empty Set\n

    \n

    \n As of jQuery 1.4, calling the\n jQuery() method with\n no arguments returns an empty jQuery set (with\n a\n .length\n property of 0). In previous versions of jQuery, this\n would return a set containing the document node.\n

    \n

    \n Working With Plain Objects\n

    \n

    \n At present, the only operations supported on plain\n JavaScript objects wrapped in jQuery are:\n .data(),.prop(),.on(),\n .off(), .trigger() and\n .triggerHandler(). The use of\n .data() (or any method requiring\n .data()) on a plain object will result in a\n new property on the object called jQuery{randomNumber}\n (eg. jQuery123456789).\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n\n
    \n 4\n
    \n\n
    \n 5\n
    \n\n
    \n 6\n
    \n\n
    \n 7\n
    \n\n
    \n 8\n
    \n\n
    \n 9\n
    \n\n
    \n 10\n
    \n\n
    \n 11\n
    \n\n
    \n 12\n
    \n\n
    \n 13\n
    \n\n
    \n 14\n
    \n\n
    \n 15\n
    \n\n
    \n 16\n
    \n\n
    \n 17\n
    \n\n
    \n 18\n
    \n\n
    \n 19\n
    \n\n
    \n 20\n
    \n\n
    \n 21\n
    \n\n
    \n 22\n
    \n\n
    \n 23\n
    \n     		\n 
    // Define a plain object
    var foo = { foo: \"bar\", hello: \"world\" };
     
    // Pass it to the jQuery function
    var $foo = $( foo );
     
    // Test accessing property values
    var test1 = $foo.prop( \"foo\" ); // bar
     
    // Test setting property values
    $foo.prop( \"foo\", \"foobar\" );
    var test2 = $foo.prop( \"foo\" ); // foobar
     
    // Test using .data() as summarized above
    $foo.data( \"keyName\", \"someValue\" );
    console.log( $foo ); // will now contain a jQuery{randomNumber} property
     
    // Test binding an event name and triggering
    $foo.on( \"eventName\", function () {
      console.log( \"eventName was called\" );
    });
     
    $foo.trigger( \"eventName\" ); // Logs \"eventName was called\"
    \n
    \n
    \n\n

    \n Should\n .trigger( \"eventName\" )\n be used, it will search for an \"eventName\" property on\n the object and attempt to execute it after any attached\n jQuery handlers are executed. It does not check whether\n the property is a function or not. To avoid this\n behavior,\n .triggerHandler( \"eventName\" )\n should be used instead.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $foo.triggerHandler( \"eventName\" ); // Also logs \"eventName was called\"
    \n
    \n
    \n
    \n
    \n

    Examples:

    \n
    \n

    \n Example:\n Find all p elements that are children of a div\n element and apply a border to them.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n\n
    \n 4\n
    \n\n
    \n 5\n
    \n\n
    \n 6\n
    \n\n
    \n 7\n
    \n\n
    \n 8\n
    \n\n
    \n 9\n
    \n\n
    \n 10\n
    \n\n
    \n 11\n
    \n\n
    \n 12\n
    \n\n
    \n 13\n
    \n\n
    \n 14\n
    \n\n
    \n 15\n
    \n\n
    \n 16\n
    \n\n
    \n 17\n
    \n\n
    \n 18\n
    \n\n
    \n 19\n
    \n     		\n 
    <!doctype html>
    <html lang=\"en\">
    <head>
      <meta charset=\"utf-8\">
      <title>jQuery demo</title>
      <script src=\"http://code.jquery.com/jquery-1.9.1.js\"></script>
    </head>
    <body>
     
    <p>one</p>
    <div><p>two</p></div>
    <p>three</p>
     
    <script>
    $( \"div > p\" ).css( \"border\", \"1px solid gray\" );
    </script>
     
    </body>
    </html>
    \n
    \n
    \n\n

    Demo:

    \n
    \n \n
    \n
    \n
    \n

    \n Example:\n Find all inputs of type radio within the first form\n in the document.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $( \"input:radio\", document.forms[ 0 ] );
    \n
    \n
    \n
    \n
    \n

    \n Example:\n Find all div elements within an XML document from\n an Ajax response.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $( \"div\", xml.responseXML );
    \n
    \n
    \n
    \n
    \n

    \n Example:\n Set the background color of the page to\n black.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $( document.body ).css( \"background\", \"black\" );
    \n
    \n
    \n
    \n
    \n

    \n Example:\n Hide all the input elements within a form.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $( myForm.elements ).hide();
    \n
    \n
    \n
    \n
    \n
    \n
    \n
    \n

    \n jQuery( html [, ownerDocument ] )Returns:\n jQuery\n

    \n
    \n

    \n Description: Creates DOM elements on the\n fly from the provided string of raw HTML.\n

    \n     \n
    \n

    \n Creating New Elements\n

    \n

    \n If a string is passed as the parameter to\n $(), jQuery examines the string to see if\n it looks like HTML (i.e., it starts with\n <tag ... >). If not, the string is\n interpreted as a selector expression, as explained\n above. But if the string appears to be an HTML snippet,\n jQuery attempts to create new DOM elements as described\n by the HTML. Then a jQuery object is created and\n returned that refers to these elements. You can perform\n any of the usual jQuery methods on this object:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $( \"<p id='test'>My <em>new</em> text</p>\" ).appendTo( \"body\" );
    \n
    \n
    \n\n

    \n For explicit parsing of a string to HTML, use the\n $.parseHTML()\n method.\n

    \n

    \n By default, elements are created with an\n ownerDocument\n matching the document into which the jQuery library was\n loaded. Elements being injected into a different\n document should be created using that document, e.g.,\n $(\"<p>hello iframe</p>\",\n $(\"#myiframe\").prop(\"contentWindow\").document).\n

    \n

    \n If the HTML is more complex than a single tag without\n attributes, as it is in the above example, the actual\n creation of the elements is handled by the browser's\n innerHTML\n mechanism. In most cases, jQuery creates a new\n <div> element and sets the innerHTML property of\n the element to the HTML snippet that was passed in. When\n the parameter has a single tag (with optional closing\n tag or quick-closing) —\n $( \"<img />\" )\n or\n $( \"<img>\" ),\n $( \"<a></a>\" )\n or\n $( \"<a>\" ) — jQuery creates the\n element using the native JavaScript\n createElement()\n function.\n

    \n

    \n When passing in complex HTML, some browsers may not\n generate a DOM that exactly replicates the HTML source\n provided. As mentioned, jQuery uses the browser\"s\n .innerHTML property to parse the passed\n HTML and insert it into the current document. During\n this process, some browsers filter out certain elements\n such as <html>,\n <title>, or\n <head>\n elements. As a result, the elements inserted may not be\n representative of the original string passed.\n

    \n

    \n Filtering isn't, however, limited to these tags. For\n example, Internet Explorer prior to version 8 will also\n convert all href properties on links to\n absolute URLs, and Internet Explorer prior to version 9\n will not correctly handle HTML5 elements without the\n addition of a separate\n compatibility layer.\n

    \n

    \n To ensure cross-platform compatibility, the snippet must\n be well-formed. Tags that can contain other elements\n should be paired with a closing tag:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $( \"<a href='http://jquery.com'></a>\" );
    \n
    \n
    \n\n

    \n Tags that cannot contain elements may be quick-closed or\n not:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n     		\n 
    $( \"<img>\" );
    $( \"<input>\" );
    \n
    \n
    \n\n

    \n When passing HTML to\n jQuery(), please also note that text nodes\n are not treated as DOM elements. With the exception of a\n few methods (such as .content()), they are\n generally otherwise ignored or removed. E.g:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n     		\n 
    var el = $( \"1<br>2<br>3\" ); // returns [<br>, \"2\", <br>]
    el = $( \"1<br>2<br>3 >\" ); // returns [<br>, \"2\", <br>, \"3 &gt;\"]
    \n
    \n
    \n\n

    This behavior is expected.

    \n

    \n As of jQuery 1.4, the second argument to\n jQuery() can accept a plain object\n consisting of a superset of the properties that can be\n passed to the\n .attr()\n method.\n

    \n

    \n Important: If the second argument is\n passed, the HTML string in the first argument must\n represent a a simple element with no attributes.\n As of jQuery 1.4, any\n event type\n can be passed in, and the following jQuery methods can\n be called:\n val,\n css,\n html,\n text,\n data,\n width,\n height, or\n offset.\n

    \n

    \n As of jQuery 1.8, any jQuery instance\n method (a method of jQuery.fn) can be used\n as a property of the object passed to the second\n parameter:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n\n
    \n 4\n
    \n\n
    \n 5\n
    \n\n
    \n 6\n
    \n\n
    \n 7\n
    \n\n
    \n 8\n
    \n     		\n 
    $( \"<div></div>\", {
      \"class\": \"my-div\",
      on: {
        touchstart: function( event ) {
          // Do something
        }
      }
    }).appendTo( \"body\" );
    \n
    \n
    \n\n

    \n The name\n \"class\" must be quoted in the object since\n it is a JavaScript reserved word, and\n \"className\" cannot be used since it refers\n to the DOM property, not the attribute.\n

    \n

    \n While the second argument is convenient, its flexibility\n can lead to unintended consequences (e.g.\n $( \"<input>\", {size: \"4\"} )\n calling the\n .size() method instead of setting the size\n attribute). The previous code block could thus be\n written instead as:\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n\n
    \n 4\n
    \n\n
    \n 5\n
    \n\n
    \n 6\n
    \n\n
    \n 7\n
    \n\n
    \n 8\n
    \n     		\n 
    $( \"<div></div>\" )
      .addClass( \"my-div\" )
      .on({
        touchstart: function( event ) {
          // Do something
        }
      })
        .appendTo( \"body\" );
    \n
    \n
    \n
    \n
    \n

    Examples:

    \n
    \n

    \n Example:\n Create a div element (and all of its contents)\n dynamically and append it to the body element.\n Internally, an element is created and its innerHTML\n property set to the given markup.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n     		\n 
    $( \"<div><p>Hello</p></div>\" ).appendTo( \"body\" )
    \n
    \n
    \n
    \n
    \n

    \n Example:\n Create some DOM elements.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n\n
    \n 4\n
    \n\n
    \n 5\n
    \n\n
    \n 6\n
    \n\n
    \n 7\n
    \n\n
    \n 8\n
    \n     		\n 
    $( \"<div/>\", {
      \"class\": \"test\",
      text: \"Click me!\",
      click: function() {
        $( this ).toggleClass( \"test\" );
      }
    })
      .appendTo( \"body\" );
    \n
    \n
    \n
    \n
    \n
    \n
    \n
    \n

    \n jQuery( callback )Returns:\n jQuery\n

    \n
    \n

    \n Description: Binds a function to be\n executed when the DOM has finished loading.\n

    \n     \n
    \n

    \n This function behaves just like\n $( document ).ready(), in that it should be\n used to wrap other $() operations on your\n page that depend on the DOM being ready. While this\n function is, technically, chainable, there really isn\"t\n much use for chaining against it.\n

    \n
    \n
    \n

    Examples:

    \n
    \n

    \n Example:\n Execute the function when the DOM is ready to be\n used.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n     		\n 
    $(function() {
      // Document is ready
    });
    \n
    \n
    \n
    \n
    \n

    \n Example:\n Use both the shortcut for $(document).ready() and\n the argument to write failsafe jQuery code using the\n $ alias, without relying on the global alias.\n

    \n
    \n \n \n \n \n \n \n \n
    \n
    \n 1\n
    \n\n
    \n 2\n
    \n\n
    \n 3\n
    \n     		\n 
    jQuery(function( $ ) {
      // Your code using failsafe $ alias here...
    });
    \n
    \n
    \n
    \n
    \n
    \n
    \n
    \n \n \n \n
    \n\n
    \n \n
    \n
    \n
    \n
    \n\n