Skip to content

Commit 8d04ef1

Browse files
committed
docs: fix typo
1 parent 888f0a1 commit 8d04ef1

11 files changed

+30
-24
lines changed

.gitattributes

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
website/** linguist-detectable=false
2+
__mock__/** linguist-detectable=false
3+
__scripts__/** linguist-detectable=false
4+
__test__/** linguist-detectable=false
5+
*.config.ts linguist-detectable=false
6+
*.test.ts linguist-detectable=false

website/src/content/docs/examples/multiple-issuer.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const baseUrl = "https://app.example.com";
1515
const dataAdapter = new SQLiteAdapter();
1616

1717
// Callback URL: `https://app.example.com/auth/callback`
18-
const rp1 = await OidcClient.create({
18+
const rp1 = await OidcClient.factory({
1919
baseUrl,
2020
issuerUrl: "https://issuer.exmaple.com",
2121
clientMetadata: {
@@ -29,7 +29,7 @@ const endpoints1 = rp1.getEndpoints();
2929
console.log(rp1.issuerMetadata);
3030

3131
// Callback URL: `https://app.example.com/another/callback`
32-
const rp2 = await OidcClient.create({
32+
const rp2 = await OidcClient.factory({
3333
baseUrl,
3434
issuerUrl: "https://another-issuer.exmaple.com",
3535
clientMetadata: {

website/src/content/docs/examples/single-issuer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { OidcClient } from "../src";
88
// import { OidcClient } from "elysia-openid-client";
99

1010
// Callback URL: `https://app.example.com/auth/callback`
11-
const rp = await OidcClient.create({
11+
const rp = await OidcClient.factory({
1212
baseUrl: "https://app.example.com",
1313
issuerUrl: "https://issuer.exmaple.com",
1414
clientMetadata: {

website/src/content/docs/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ bun add elysia-openid-client
1111
import Elysia from "elysia";
1212
import { OidcClient } from "elysia-openid-client";
1313

14-
const rp = await OidcClient.create({
14+
const rp = await OidcClient.factory({
1515
baseUrl: "https://app.example.com", // RP URL
1616
issuerUrl: "https://issuer.example.com", // OP URL
1717
clientMetadata: {

website/src/content/docs/guides/data-adapter.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Data Adapter
66
Defines how session data is stored.
77

88
```typescript
9-
const rp = await OidcClient.create({
9+
const rp = await OidcClient.factory({
1010
//...
1111
dataAdapter: OIDCClientDataAdapter,
1212
//...
@@ -53,7 +53,7 @@ const memoryAdapter = new LokiInMemoryAdapter();
5353

5454
// Persistence to file
5555
import { LokiFileAdapter } from 'elysia-openid-client/dataAdapters/LokiFileAdapter';
56-
const fileAdapter = await LokiFileAdapter.create({
56+
const fileAdapter = await LokiFileAdapter.factory({
5757
filename: "path/to/sessions.db"
5858
});
5959
```
@@ -70,10 +70,10 @@ bun add lowdb
7070
import { LowdbAdapter } from 'elysia-openid-client/dataAdapters/LowdbAdapter';
7171

7272
// In-memory
73-
const memoryAdapter = await LowdbAdapter.create();
73+
const memoryAdapter = await LowdbAdapter.factory();
7474

7575
// Persistence to file
76-
const fileAdapter = await LowdbAdapter.create({
76+
const fileAdapter = await LowdbAdapter.factory({
7777
filename: "sessions.json",
7878
})
7979
```
@@ -105,7 +105,7 @@ export class MyDataAdapter implements OIDCClientDataAdapter {
105105

106106
// app.ts
107107
import { MyDataAdapter } from 'path/to/MyDataAdapter';
108-
const rp = await OidcClient.create({
108+
const rp = await OidcClient.factory({
109109
//...
110110
dataAdapter: new MyDataAdapter(),
111111
//...

website/src/content/docs/guides/hooks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Hooks
66
Determine the validity of the session in `onBeforeHandle`, and return `sessionStatus` and `sessionClaims` from the [`resolve` hook](https://elysiajs.com/life-cycle/before-handle.html#resolve).
77

88
```typescript
9-
const rp = await OidcClient.create({ ... });
9+
const rp = await OidcClient.factory({ ... });
1010
const hookOptions: AuthHookOptions = { ... };
1111
const hook = rp.getAuthHook(hookOptions);
1212
```

website/src/content/docs/guides/logger.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Logger
66
Defines logger.
77

88
```typescript
9-
const rp = await OidcClient.create({
9+
const rp = await OidcClient.factory({
1010
//...
1111
logger: OIDCClientLogger | null,
1212
//...
@@ -46,7 +46,7 @@ bun add pino
4646

4747
```typescript
4848
import pino from "pino";
49-
const rp = await OidcClient.create({
49+
const rp = await OidcClient.factory({
5050
//...
5151
logger: pino(),
5252
//...
@@ -60,7 +60,7 @@ Using [Console](https://bun.sh/docs/api/console).
6060
```typescript
6161
import { consoleLogger } from "elysia-openid-client/loggers/consoleLogger";
6262
const minimumLogLevel = "debug"; // same as pino
63-
const rp = await OidcClient.create({
63+
const rp = await OidcClient.factory({
6464
//...
6565
logger: consoleLogger(minimumLogLevel),
6666
//...

website/src/content/docs/ja/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ bun add elysia-openid-client
1111
import Elysia from "elysia";
1212
import { OidcClient } from "elysia-openid-client";
1313

14-
const rp = await OidcClient.create({
14+
const rp = await OidcClient.factory({
1515
baseUrl: "https://app.example.com", // RP URL
1616
issuerUrl: "https://issuer.example.com", // OP URL
1717
clientMetadata: {

website/src/content/docs/ja/guides/data-adapter.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Data Adapter
66
セッション情報の保存方法を定義したもの。
77

88
```typescript
9-
const rp = await OidcClient.create({
9+
const rp = await OidcClient.factory({
1010
//...
1111
dataAdapter: OIDCClientDataAdapter,
1212
//...
@@ -53,7 +53,7 @@ const memoryAdapter = new LokiInMemoryAdapter();
5353

5454
// 永続化モード
5555
import { LokiFileAdapter } from 'elysia-openid-client/dataAdapters/LokiFileAdapter';
56-
const fileAdapter = await LokiFileAdapter.create({
56+
const fileAdapter = await LokiFileAdapter.factory({
5757
filename: "path/to/sessions.db"
5858
});
5959
```
@@ -70,10 +70,10 @@ bun add lowdb
7070
import { LowdbAdapter } from 'elysia-openid-client/dataAdapters/LowdbAdapter';
7171

7272
// インメモリーモード
73-
const memoryAdapter = await LowdbAdapter.create();
73+
const memoryAdapter = await LowdbAdapter.factory();
7474

7575
// 永続化モード
76-
const fileAdapter = await LowdbAdapter.create({
76+
const fileAdapter = await LowdbAdapter.factory({
7777
filename: "sessions.json",
7878
})
7979
```
@@ -105,7 +105,7 @@ export class MyDataAdapter implements OIDCClientDataAdapter {
105105

106106
// app.ts
107107
import { MyDataAdapter } from 'path/to/MyDataAdapter';
108-
const rp = await OidcClient.create({
108+
const rp = await OidcClient.factory({
109109
//...
110110
dataAdapter: new MyDataAdapter(),
111111
//...

website/src/content/docs/ja/guides/hooks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Endpoints
2+
title: Hooks
33
# description:
44
---
55

66
`onBeforeHandle` フックでCookieを元にセッションが有効かどうかを判断し、 [`resolve` フック](https://elysiajs.com/life-cycle/before-handle.html#resolve)から `sessionStatus``sessionClaims` を返す。
77

88
```typescript
9-
const rp = await OidcClient.create({ ... });
9+
const rp = await OidcClient.factory({ ... });
1010
const hookOptions: AuthHookOptions = { ... };
1111
const hook = rp.getAuthHook(hookOptions);
1212
```

website/src/content/docs/ja/guides/logger.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Logger
66
ロガーを定義する。
77

88
```typescript
9-
const rp = await OidcClient.create({
9+
const rp = await OidcClient.factory({
1010
//...
1111
logger: OIDCClientLogger | null,
1212
//...
@@ -47,7 +47,7 @@ bun add pino
4747

4848
```typescript
4949
import pino from "pino";
50-
const rp = await OidcClient.create({
50+
const rp = await OidcClient.factory({
5151
//...
5252
logger: pino(),
5353
//...
@@ -61,7 +61,7 @@ const rp = await OidcClient.create({
6161
```typescript
6262
import { consoleLogger } from "elysia-openid-client/loggers/consoleLogger";
6363
const minimumLogLevel = "debug"; // pinoと同様
64-
const rp = await OidcClient.create({
64+
const rp = await OidcClient.factory({
6565
//...
6666
logger: consoleLogger(minimumLogLevel),
6767
//...

0 commit comments

Comments
 (0)