Skip to content

Commit

Permalink
flesh out svelte/register docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Rich-Harris authored May 4, 2019
1 parent df602b7 commit 8f2ccc4
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions site/content/docs/03-run-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8f2ccc4

Please sign in to comment.