Skip to content

Fix documentation related to setInputFiles function#2205

Open
JunNishimura wants to merge 11 commits into
grafana:mainfrom
JunNishimura:fix/setinputfiles_md
Open

Fix documentation related to setInputFiles function#2205
JunNishimura wants to merge 11 commits into
grafana:mainfrom
JunNishimura:fix/setinputfiles_md

Conversation

@JunNishimura

@JunNishimura JunNishimura commented Mar 20, 2026

Copy link
Copy Markdown

What?

grafana/k6#4655

Regarding the issues discussed above, I have made corrections to the type definitions in the following pull request.

grafana/k6-DefinitelyTyped#115

Accordingly, the documentation was revised.

  • change file.buffer type from ArrayBuffer to string
  • correct mimeType property name of Page in examples
  • correct examples where a selector is not passed to the setInputFiles function

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the npm start command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/k6/next folder of the documentation.
  • I have reflected my changes in the docs/sources/k6/v{most_recent_release} folder of the documentation.
  • I have reflected my changes in the relevant folders of the two previous k6 versions of the documentation (if still applicable to previous versions).
  • I have made my changes in the docs/sources/k6/next folder of the documentation.

Related PR(s)/Issue(s)

grafana/k6#4655
grafana/k6-DefinitelyTyped#115

@JunNishimura JunNishimura requested review from a team and heitortsergent as code owners March 20, 2026 08:49
@JunNishimura JunNishimura requested review from codebien and oleiade and removed request for a team March 20, 2026 08:49
@cla-assistant

cla-assistant Bot commented Mar 20, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@JunNishimura JunNishimura changed the title Fix documentation related to setInputFiles function [WIP] Fix documentation related to setInputFiles function Mar 20, 2026
@JunNishimura JunNishimura changed the title [WIP] Fix documentation related to setInputFiles function Fix documentation related to setInputFiles function Mar 20, 2026

@codebien codebien left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey @JunNishimura, can you sign the CLA, please? This is a requires step to merge this pull request.

@JunNishimura

Copy link
Copy Markdown
Author

@codebien

Hi, I signed the CLA. I would appreciate it if you review again. Thanks!

@oleiade oleiade left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM — documentation fix.

@heitortsergent heitortsergent self-assigned this May 4, 2026
@heitortsergent heitortsergent added the Area: OSS Content Improvements or additions to community/oss documentation label May 4, 2026
@oleiade

oleiade commented May 7, 2026

Copy link
Copy Markdown
Contributor

I'm confused why the code examples are failing when they were not before? Any idea @heitortsergent ?

@heitortsergent

Copy link
Copy Markdown
Collaborator

@oleiade I'm confused as well... I don't see any regressions, besides removing the {{ code }} blocks. But also, reading the code snippet, it does look like it should fail since it's trying to read a local file, and we probably need to add a <!-- md-k6:skip --> there. Wdyt? 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: OSS Content Improvements or additions to community/oss documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants