Skip to content

Commit dd1e516

Browse files
digitalsadhudigitalsadhu
committed
chore: update to Podium v5
1 parent bcee463 commit dd1e516

15 files changed

+131
-119
lines changed

‎docs/api/document.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ or [`.buildScriptElement()`](https://github.com/podium-lib/utils#buildscriptelem
219219
methods found in the `@podium/utils` package:
220220

221221
```js
222-
const utils = require('@podium/utils');
222+
import utils from '@podium/utils';
223223

224224
[ ... ]
225225

‎docs/api/getting_started.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Example of setting up a podlet server in all HTTP frameworks supported by the Po
4545
<TabItem value="express" label="Express">
4646

4747
```js
48-
const express = require('express');
49-
const Podlet = require('@podium/podlet');
48+
import express from 'express';
49+
import Podlet from '@podium/podlet';
5050

5151
const app = express();
5252

@@ -77,9 +77,9 @@ app.listen(7100);
7777
<TabItem value="hapi" label="Hapi">
7878

7979
```js
80-
const HapiPodlet = require('@podium/hapi-podlet');
81-
const Podlet = require('@podium/podlet');
82-
const Hapi = require('hapi');
80+
import HapiPodlet from '@podium/hapi-podlet';
81+
import Podlet from '@podium/podlet';
82+
import Hapi from 'hapi';
8383

8484
const app = Hapi.Server({
8585
host: 'localhost',
@@ -122,9 +122,9 @@ app.start();
122122
<TabItem value="fastify" label="Fastify">
123123

124124
```js
125-
const fastifyPodlet = require('@podium/fastify-podlet');
126-
const fastify = require('fastify');
127-
const Podlet = require('@podium/podlet');
125+
import fastifyPodlet from '@podium/fastify-podlet';
126+
import fastify from 'fastify';
127+
import Podlet from '@podium/podlet';
128128

129129
const app = fastify();
130130

@@ -165,9 +165,9 @@ start();
165165
<TabItem value="http" label="HTTP">
166166

167167
```js
168-
const { HttpIncoming } = require('@podium/utils');
169-
const Podlet = require('@podium/podlet');
170-
const http = require('http');
168+
import { HttpIncoming } from '@podium/utils';
169+
import Podlet from '@podium/podlet';
170+
import http from 'http';
171171

172172
const podlet = new Podlet({
173173
name: 'myPodlet',

‎docs/api/incoming.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ framework.
3535
<TabItem value="express" label="Express">
3636

3737
```js
38-
const express = require('express');
39-
const Layout = require('@podium/layout');
38+
import express from 'express';
39+
import Layout from '@podium/layout';
4040

4141
const app = express();
4242

@@ -93,9 +93,9 @@ app.listen(7000);
9393
<TabItem value="hapi" label="Hapi">
9494

9595
```js
96-
const HapiLayout = require('@podium/hapi-layout');
97-
const Layout = require('@podium/layout');
98-
const Hapi = require('hapi');
96+
import HapiLayout from '@podium/hapi-layout';
97+
import Layout from '@podium/layout';
98+
import Hapi from 'hapi';
9999

100100
const app = Hapi.Server({
101101
host: 'localhost',
@@ -160,9 +160,9 @@ app.start();
160160
<TabItem value="fastify" label="Fastify">
161161

162162
```js
163-
const FastifyLayout = require('@podium/fastify-layout');
164-
const fastify = require('fastify');
165-
const Layout = require('@podium/layout');
163+
import FastifyLayout from '@podium/fastify-layout';
164+
import fastify from 'fastify';
165+
import Layout from '@podium/layout';
166166

167167
const app = fastify({ logger: true });
168168

@@ -226,9 +226,9 @@ start();
226226
<TabItem value="http" label="HTTP">
227227

228228
```js
229-
const { HttpIncoming } = require('@podium/utils');
230-
const Layout = require('@podium/layout');
231-
const http = require('http');
229+
import { HttpIncoming } from '@podium/utils';
230+
import Layout from '@podium/layout';
231+
import http from 'http';
232232

233233
const layout = new Layout({
234234
name: 'myLayout',
@@ -289,7 +289,7 @@ server.listen(7000);
289289
Create a new HttpIncoming instance.
290290

291291
```js
292-
const { HttpIncoming } = require('@podium/utils');
292+
import { HttpIncoming } from '@podium/utils';
293293
const incoming = new HttpIncoming(request, response, params);
294294
```
295295

‎docs/api/layout.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ Building a simple layout server including two podlets:
6767
<TabItem value="express" label="Express">
6868

6969
```js
70-
const express = require('express');
71-
const Layout = require('@podium/layout');
70+
import express from 'express';
71+
import Layout from '@podium/layout';
7272

7373
const layout = new Layout({
7474
name: 'myLayout',
@@ -109,9 +109,9 @@ app.listen(7000);
109109
<TabItem value="hapi" label="Hapi">
110110

111111
```js
112-
const HapiLayout = require('@podium/hapi-layout');
113-
const Layout = require('@podium/layout');
114-
const Hapi = require('hapi');
112+
import HapiLayout from '@podium/hapi-layout';
113+
import Layout from '@podium/layout';
114+
import Hapi from 'hapi';
115115

116116
const app = Hapi.Server({
117117
host: 'localhost',
@@ -164,9 +164,9 @@ app.start();
164164
<TabItem value="fastify" label="Fastify">
165165

166166
```js
167-
const fastifyLayout = require('@podium/fastify-layout');
168-
const fastify = require('fastify');
169-
const Layout = require('@podium/layout');
167+
import fastifyLayout from '@podium/fastify-layout';
168+
import fastify from 'fastify';
169+
import Layout from '@podium/layout';
170170

171171
const app = fastify();
172172

@@ -217,9 +217,9 @@ start();
217217
<TabItem value="http" label="HTTP">
218218

219219
```js
220-
const { HttpIncoming } = require('@podium/utils');
221-
const Layout = require('@podium/layout');
222-
const http = require('http');
220+
import { HttpIncoming } from '@podium/utils';
221+
import Layout from '@podium/layout';
222+
import http from 'http';
223223

224224
const layout = new Layout({
225225
name: 'myLayout',
@@ -690,7 +690,7 @@ app.register({
690690
options: layout,
691691
});
692692

693-
app.register(require('@hapi/inert'));
693+
app.register(await import('@hapi/inert'));
694694

695695
app.route({
696696
method: 'GET',
@@ -715,7 +715,7 @@ const layout = new Layout({
715715

716716
app.register(fastifyLayout, layout);
717717

718-
app.register(require('fastify-static'), {
718+
app.register(await import('fastify-static'), {
719719
root: './src/js/',
720720
});
721721

@@ -799,7 +799,7 @@ app.register({
799799
options: layout,
800800
});
801801

802-
app.register(require('@hapi/inert'));
802+
app.register(await import('@hapi/inert'));
803803

804804
app.route({
805805
method: 'GET',
@@ -830,7 +830,7 @@ const layout = new Layout({
830830

831831
app.register(fastifyLayout, layout);
832832

833-
app.register(require('fastify-static'), {
833+
app.register(await import('fastify-static'), {
834834
root: './src/js/',
835835
});
836836

@@ -983,7 +983,7 @@ app.register({
983983
options: layout,
984984
});
985985

986-
app.register(require('@hapi/inert'));
986+
app.register(await import('@hapi/inert'));
987987

988988
app.route({
989989
method: 'GET',
@@ -1008,7 +1008,7 @@ const layout = new Layout({
10081008

10091009
app.register(fastifyLayout, layout);
10101010

1011-
app.register(require('fastify-static'), {
1011+
app.register(await import('fastify-static'), {
10121012
root: './src/css/',
10131013
});
10141014

@@ -1093,7 +1093,7 @@ app.register({
10931093
options: layout,
10941094
});
10951095

1096-
app.register(require('@hapi/inert'));
1096+
app.register(await import('@hapi/inert'));
10971097

10981098
app.route({
10991099
method: 'GET',
@@ -1124,7 +1124,7 @@ const layout = new Layout({
11241124

11251125
app.register(fastifyLayout, layout);
11261126

1127-
app.register(require('fastify-static'), {
1127+
app.register(await import('fastify-static'), {
11281128
root: './src/css/',
11291129
});
11301130

@@ -1513,8 +1513,8 @@ An instance of the [`HttpIncoming`](incoming.md) class.
15131513
<TabItem value="http" label="HTTP">
15141514

15151515
```js
1516-
const { HttpIncoming } = require('@podium/utils');
1517-
const Layout = require('@podium/layout');
1516+
import { HttpIncoming } from '@podium/utils';
1517+
import Layout from '@podium/layout';
15181518

15191519
const layout = new Layout({
15201520
name: 'myLayout',
@@ -1805,7 +1805,7 @@ parsers to it.
18051805
Example of registering a custom third party context parser to the context:
18061806

18071807
```js
1808-
const Parser = require('my-custom-parser');
1808+
import Parser from 'my-custom-parser';
18091809

18101810
const layout = new Layout({
18111811
name: 'myLayout',

‎docs/api/podlet.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ Building a simple podlet server.
5858
<TabItem value="express" label="Express">
5959

6060
```js
61-
const express = require('express');
62-
const Podlet = require('@podium/podlet');
61+
import express from 'express';
62+
import Podlet from '@podium/podlet';
6363

6464
const app = express();
6565

@@ -90,9 +90,9 @@ app.listen(7100);
9090
<TabItem value="hapi" label="Hapi">
9191

9292
```js
93-
const HapiPodlet = require('@podium/hapi-podlet');
94-
const Podlet = require('@podium/podlet');
95-
const Hapi = require('hapi');
93+
import HapiPodlet from '@podium/hapi-podlet';
94+
import Podlet from '@podium/podlet';
95+
import Hapi from 'hapi';
9696

9797
const app = Hapi.Server({
9898
host: 'localhost',
@@ -135,9 +135,9 @@ app.start();
135135
<TabItem value="fastify" label="Fastify">
136136

137137
```js
138-
const fastifyPodlet = require('@podium/fastify-podlet');
139-
const fastify = require('fastify');
140-
const Podlet = require('@podium/podlet');
138+
import fastifyPodlet from '@podium/fastify-podlet';
139+
import fastify from 'fastify';
140+
import Podlet from '@podium/podlet';
141141

142142
const app = fastify();
143143

@@ -178,9 +178,9 @@ start();
178178
<TabItem value="http" label="HTTP">
179179

180180
```js
181-
const { HttpIncoming } = require('@podium/utils');
182-
const Podlet = require('@podium/podlet');
183-
const http = require('http');
181+
import { HttpIncoming } from '@podium/utils';
182+
import Podlet from '@podium/podlet';
183+
import http from 'http';
184184

185185
const podlet = new Podlet({
186186
name: 'myPodlet',
@@ -1332,7 +1332,7 @@ app.register({
13321332
options: podlet,
13331333
});
13341334

1335-
app.register(require('@hapi/inert'));
1335+
app.register(await import('@hapi/inert'));
13361336

13371337
app.route({
13381338
method: 'GET',
@@ -1358,7 +1358,7 @@ const podlet = new Podlet({
13581358

13591359
app.register(fastifyPodlet, podlet);
13601360

1361-
app.register(require('fastify-static'), {
1361+
app.register(await import('fastify-static'), {
13621362
root: './src/js/',
13631363
});
13641364

@@ -1418,7 +1418,7 @@ app.register({
14181418
options: podlet,
14191419
});
14201420

1421-
app.register(require('@hapi/inert'));
1421+
app.register(await import('@hapi/inert'));
14221422

14231423
app.route({
14241424
method: 'GET',
@@ -1450,7 +1450,7 @@ const podlet = new Podlet({
14501450

14511451
app.register(fastifyPodlet, podlet);
14521452

1453-
app.register(require('fastify-static'), {
1453+
app.register(await import('fastify-static'), {
14541454
root: './src/js/',
14551455
});
14561456

@@ -1572,7 +1572,7 @@ app.register({
15721572
options: podlet,
15731573
});
15741574

1575-
app.register(require('@hapi/inert'));
1575+
app.register(await import('@hapi/inert'));
15761576

15771577
app.route({
15781578
method: 'GET',
@@ -1598,7 +1598,7 @@ const podlet = new Podlet({
15981598

15991599
app.register(fastifyPodlet, podlet);
16001600

1601-
app.register(require('fastify-static'), {
1601+
app.register(await import('fastify-static'), {
16021602
root: './src/css/',
16031603
});
16041604

@@ -1658,7 +1658,7 @@ app.register({
16581658
options: podlet,
16591659
});
16601660

1661-
app.register(require('@hapi/inert'));
1661+
app.register(await import('@hapi/inert'));
16621662

16631663
app.route({
16641664
method: 'GET',
@@ -1690,7 +1690,7 @@ const podlet = new Podlet({
16901690

16911691
app.register(fastifyPodlet, podlet);
16921692

1693-
app.register(require('fastify-static'), {
1693+
app.register(await import('fastify-static'), {
16941694
root: './src/css/',
16951695
});
16961696

@@ -2231,8 +2231,8 @@ This method takes the following arguments:
22312231
An instance of the [`HttpIncoming`](incoming.md) class.
22322232

22332233
```js
2234-
const { HttpIncoming } = require('@podium/utils');
2235-
const Podlet = require('@podium/podlet');
2234+
import { HttpIncoming } from '@podium/utils';
2235+
import Podlet from '@podium/podlet';
22362236

22372237
const podlet = new Podlet({
22382238
name: 'myPodlet',

0 commit comments

Comments
 (0)