From d92860d1edb1f86d6c7bf12fbe64235fb6162e17 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Fri, 3 May 2019 23:43:18 -0400 Subject: [PATCH] flesh out svelte/register docs --- site/content/docs/03-run-time.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/site/content/docs/03-run-time.md b/site/content/docs/03-run-time.md index 76cb1a9bb1..ed19c3b009 100644 --- a/site/content/docs/03-run-time.md +++ b/site/content/docs/03-run-time.md @@ -556,20 +556,33 @@ You can see a full example on the [animations tutorial](tutorial/animate) * TODO could have nice little interactive widgets showing the different functions, maybe + ### `svelte/register` -To render Svelte components server-side, use `require('svelte/register')`; after this, you can use `require` to include any `.svelte` file. +To render Svelte components in Node.js without bundling, use `require('svelte/register')`. After that, you can use `require` to include any `.svelte` file. ```js require('svelte/register'); -const App = require('./App.svelte'); +const App = require('./App.svelte').default; ... -App.default.render({ title: 'name' }); +const { html, css, head } = App.render({ answer: 42 }); ``` +> The `.default` is necessary because we're converting from native JavaScript modules to the CommonJS modules recognised by Node. Note that if your component imports JavaScript modules, they will fail to load in Node and you will need to use a bundler instead. + +To set compile options, or to use a custom file extension, call the `register` hook as a function: + +```js +require('svelte/register')({ + extensions: ['.customextension'], // defaults to ['.html', '.svelte'] + preserveComments: true +}); +``` + + ### Client-side component API #### Creating a component