25 lines
836 B
Markdown
25 lines
836 B
Markdown
# Function: getPlaygroundUrl()
|
|
|
|
> **getPlaygroundUrl**(`options`): `string`
|
|
|
|
Gets the URL to a LiveCodes playground (as a string) from the provided [options](https://livecodes.io/docs/sdk/js-ts#embed-options).
|
|
This can be useful for providing links to run code in playgrounds.
|
|
|
|
## Parameters
|
|
|
|
• **options**: [`EmbedOptions`](../interfaces/EmbedOptions.md) = `{}`
|
|
|
|
The [options](https://livecodes.io/docs/sdk/js-ts#embed-options) for the playground.
|
|
|
|
## Returns
|
|
|
|
`string`
|
|
|
|
- The URL of the playground (as a string).
|
|
|
|
large objects like config and params are store in the url hash params while the rest are in the search params
|
|
unless config is a string in which case it is stored in searchParams
|
|
|
|
## Defined in
|
|
|
|
[index.ts:391](https://github.com/live-codes/livecodes/blob/7617d5c8be5a2a8be8133f973d9e69eb9f86434d/src/sdk/index.ts#L391) |