Skip to content
Fastify plugin for @podium/podlet
Branch: master
Clone or download
trygve-lie Merge pull request #24 from podium-lib/greenkeeper/@podium/podlet-4.1.1
Update @podium/podlet to the latest version 🚀
Latest commit 02d45ca Jul 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example Clean up example Apr 20, 2019
lib Do not run proxy parsing twice Jun 21, 2019
test Use request from @podium/test-utils Jun 21, 2019
.eslintignore Initial commit Apr 20, 2019
.eslintrc Initial commit Apr 20, 2019
.gitignore Initial commit Apr 20, 2019
.npmrc Initial commit Apr 20, 2019
.prettierrc Initial commit Apr 20, 2019
.travis.yml node v12.0.0 Apr 24, 2019
README.md Update example in doc Apr 21, 2019
package.json Merge pull request #24 from podium-lib/greenkeeper/@podium/podlet-4.1.1 Jul 4, 2019

README.md

@podium/fastify-podlet

Fastify plugin for @podium/podlet.

Dependencies Build Status Known Vulnerabilities Greenkeeper badge

Module for building @podium/podlet servers with fastify. For writing podlets, please see the Podium documentation.

Installation

$ npm install @podium/fastify-podlet

Requirements

This module require Fastify v2.0.0 or newer.

Simple usage

Build a simple podlet server:

const fastifyPodlet = require('@podium/fastify-podlet');
const fastify = require('fastify');
const Podlet = require('@podium/podlet');

const app = fastify();

const podlet = new Podlet({
    pathname: '/',
    version: '2.0.0',
    name: 'podletContent',
});

app.register(fastifyPodlet, podlet);

app.get(podlet.content(), async (request, reply) => {
    if (reply.app.podium.context.locale === 'nb-NO') {
        reply.podiumSend('<h2>Hei verden</h2>');
        return;
    }
    reply.podiumSend('<h2>Hello world</h2>');
});

app.get(podlet.manifest(), async (request, reply) => {
    reply.send(podlet);
});

const start = async () => {
  try {
    await app.listen(7100)
    app.log.info(`server listening on ${app.server.address().port}`)
  } catch (err) {
    app.log.error(err)
    process.exit(1)
  }
};
start();

Register plugin

The plugin is registered by passing an instance of this plugin to the fastify server .register() method together with an instance of the @podium/podlet class.

app.register(FastifyPodlet, podlet);

Request params

On each request @podium/podlet will run a set of operations, such as deserialization of the @podium/context, on the request. When doing so @podium/podlet will write parameters to reply.app.podium which is accessible inside a request handelers.

app.get(podlet.content(), async (request, reply) => {
    if (reply.app.podium.context.locale === 'nb-NO') {
        reply.podiumSend('<h2>Hei verden</h2>');
        return;
    }
    reply.podiumSend('<h2>Hello world</h2>');
});

reply.podiumSend(fragment)

When in development mode this method will wrap the provided fragment in a default HTML document before dispatching. When not in development mode, this method will just dispatch the fragment.

See development mode for further information.

License

Copyright (c) 2019 FINN.no

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.