akili-connect

akili-connect

Library to implement server rendering for Akili framework.
It is based on jsdom.

Example

const akiliConnect = require('akili-connect');
const express = require('express');
const path = require('path');
const app = express();

const middleware = akiliConnect({
  indexFile: path.join(__dirname, 'public/templates/index.html')
});

app.get('/', middleware.route);
app.get('/home', middleware.route);
app.get('/docs/*', middleware.route);
app.get('*', middleware.index);

app.listen(3000, function () {
  console.log('Server run on 3000 port');
});

Description

All you need is to use route middleware for the necessary routing path and index middleware to get index file.

Options

• {string} indexFile - path to index file
• {string} [indexUrl] - index middleware url (if you want to change * to something special)
• {number} [port] - the application port, by default it will be set automatically
• {string} [protocol] - the application port, by default it will be set automatically
• {string} [host] - the application host, by default it will be set automatically
• {number} [timeout=10000] - The time after which the application will be rendered in any case, even if it did not have time to fully load
• {Object} [jsdomOptions] - jsdom options
• {function} [onDomInit] - the function which will be called after dom creation. You can change window state here before Akili application will be initialized.

Polyfills

You might need missing functions in jsdom or stubs for them. You can write it yourself.

const polyfill = require('akili-connect/polyfill');

polyfill.someFunction = ((window) => {
  window.someFunction = () => {};
});

Client side

Don't forget to initialize your Akili application on the client side!
Server sends the part of html to replace only the root element content.

document.addEventListener('DOMContentLoaded', () => {
  Akili.init(document.body).catch((err) => console.error(err));;
});