The TypeScriptExample component uses ts-blank-space ↗︎ to remove TypeScript-specific syntax from your example and provide a JavaScript tab. This reduces maintenance burden by only having a single example to maintain.
Do not use TypeScriptExample for a snippet that only contains types, such as a type alias, an interface, or a declare statement. Types have no JavaScript equivalent, so the JavaScript tab would be empty. Use a plain ts code block instead:
```ts
type WorkflowInstanceEvent = {
instanceId: string;
timestamp: string;
};
```The build fails if a TypeScriptExample produces an empty JavaScript tab.
import { TypeScriptExample } from "~/components";
<TypeScriptExample code={{
collapse: "1-2"
}}>
```ts
// comment to demonstrate
// collapsible sections
interface Environment {
KV: KVNamespace;
}
export default {
async fetch(req, env, ctx): Promise<Response> {
if (req !== "POST") {
return new Response("Method Not Allowed", {
status: 405,
headers: {
"Allow": "POST"
}
});
}
await env.KV.put("foo", "bar");
return new Response();
}
} satisfies ExportedHandler<Environment>
```
</TypeScriptExample>type: string
An optional filename, ending in .ts.
.ts will be replaced by .js for the JavaScript tab.
type: boolean
If set to true, a Run Worker in Playground button will appear on the JavaScript tab.
type: boolean
If set to true, the JavaScript and TypeScript tabs render without their own Tabs wrapper. Use this to place them inside a parent Tabs component next to other languages, for example a Python tab:
<Tabs syncKey="workersExamples">
<TypeScriptExample omitTabs={true}>
```ts
export class MyDurableObject extends DurableObject<Env> {}
```
</TypeScriptExample>
<TabItem label="Python">
```python
class MyDurableObject(DurableObject):
pass
```
</TabItem>
</Tabs>type: object
Props to pass to the Astro Code component ↗︎.
These props will apply to both code blocks and so options like collapse may not work as expected, as lines may be removed from the TypeScript code.