getPlatformProxy "persist" docs are missleading

[clibequilibrium]

Which Cloudflare product(s) does this pertain to?

Wrangler

What versions & operating system are you using?

v3+

Please provide a link to a minimal reproduction

No response

Describe the Bug

Hi, getPlatformProxy , persist option expects a boolean or string. However if the user passes a string path it is not respected. See this line in wrangler https://github.com/cloudflare/workers-sdk/blob/d34ef3d5b0e45470e6c06a7bd24a498f85b98af8/packages/wrangler/src/api/integrations/platform/index.ts#L226

This fails:

platform = await getPlatformProxy({
		persist:  './test-path'
	});

This succeeds:

platform = await getPlatformProxy({
		persist: { path: './test-path' }
	});

Either docs need to be edited or wrangler has to be fixed to respect the string parameter.

https://developers.cloudflare.com/workers/wrangler/api/#getplatformproxy

[dario-piotrowicz]

Hi @clibequilibrium 🙂 👋

Thanks for the issue 🙂

Could you please clarify what part of the docs you find incorrect and what you find incorrect about it?

I'm confused because when I navigate to https://developers.cloudflare.com/workers/wrangler/api/#getplatformproxy this is what I see for the persist option:

The docs do seem to say that persist is either a boolean or an object of the shape { path: string } (and not a boolean or string)

am I missing something here? 🤔

[clibequilibrium]

Hi @clibequilibrium 🙂 👋

Thanks for the issue 🙂

Could you please clarify what part of the docs you find incorrect and what you find incorrect about it?

I'm confused because when I navigate to https://developers.cloudflare.com/workers/wrangler/api/#getplatformproxy this is what I see for the persist option:

The docs do seem to say that persist is either a boolean or an object of the shape { path: string } (and not a boolean or string)

am I missing something here? 🤔

Hi, thank you!

Yes the part that is wrong is:

The persist flag actually expects an object not a string. So specifying the path like so:

persist:  './path'

will not work. Only

	persist: { path: './path' }

will work. See this line https://github.com/cloudflare/workers-sdk/blob/d34ef3d5b0e45470e6c06a7bd24a498f85b98af8/packages/wrangler/src/api/integrations/platform/index.ts#L226

If the user just passes the string, wrangler will not consume it as it expects an object with the variable path in it.

[dario-piotrowicz]

Thank you for the clarification @clibequilibrium 🙂

Yes you're right, I didn't notice that bit, that's indeed a small mistake in the getPlatformProxy docs, I've transferred the issue to the docs repo 🙂