uio — Documentation française

Sommaire

• Installation
• Démarrage rapide
• Composants
• Contexte
• Schéma
• Sucres syntaxiques

Installation

npm install ...

Démarrage rapide

index.js

const App = require('uio');

const app = new App();

app
  .get('/', 'Hello World')
  .start();

// OU

app
  .get('/', () => 'Hello World')
  .start();

// OU

const Home = {
  path: '/',
  get() {
    return 'Hello World';
  }
};

app
  .registerComponent(Home)
  .start();

npm run dev

Démarre le serveur sur localhost:7890

Composants

Déclaration d'un composant

Attributs	Descriptions	Types	Requis	Valeur par défaut
name		String		undefined
path		String	x
get|post|put|...		Function => Anything		undefined
params		UioValidatorSchema		undefined
query		UioValidatorSchema		undefined
body		UioValidatorSchema		undefined
headers		PlainObject		undefined

Enregistrer un composant

const App = require('uio');

const app = new App();

const Users = {
  path: '/users/',
  get() {
    // get users
  },
  post() {
    // create a user
  }
}

app
  .registerComponent(Users)
  .start();

Enregistrer un dossier de composant

const App = require('uio');

const app = new App();

app
  .registerDirectory('components')
  .start();

Contexte

Le contexte est fourni aux méthodes HTTP de vos composants :

/components/Example.js

const Example = {
  name: 'Example',
  path: '/example',
  get(context) {
    console.log(context);
    // do your stuff
  },
};

/components/User.js

const User = {
  name: 'User',
  path: '/user/:id',
  get({
    params,
  }) {
    return `My id is ${params.id}`/;
  },
};

Contenu du contexte

headers
hostname
ip
method
params
protocol
query
req
res
socket
url

Schéma

Cette syntaxe est encore en brouillon et ne reflète pas le résultat final

module.exports = {
  name: 'User',
  path: '/user/:id',

  post({
    body,
    $db,
  }) {
    // à ce stade les attributs du body ont été validé par UioValidator
  },

  body: {
    username: {
      type: String,
      minLength: 3,
      maxLength: 40,
    },
    password: {
      type: String,
      minLength: 8,
    },
    email: {
      type: String,
      format: 'email',
    },
  },
  bodyOptions: {
    removeUnwantedAttributes: true,
  },
};

Sucres syntaxiques

Combiner les méthodes http et options

// combine method
module.exports = {
  path: '/exemple',

  'patch,put'() {
    return 'This method will be use for PATCH and PUT request'
  },
};

// setup options for multiple method
module.exports = {
  path: '/exemple',

  get() {

  },
  post() {

  },

  'get,post$options': {
    // your options for GET AND POST methods
  }
};