Skip to content

Commit

Permalink
Deploying to gh-pages from @ a38c26f 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
dhmlau committed Jul 20, 2023
1 parent a38c26f commit 86c839d
Show file tree
Hide file tree
Showing 2,996 changed files with 30,171 additions and 15 deletions.
5 changes: 4 additions & 1 deletion pages/en/lb4/Getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ summary: Write and run a LoopBack 4 "Hello World" project in TypeScript.

## Prerequisites

Install [Node.js](https://nodejs.org/en/download/) (version 10 or higher) if it
Install [Node.js](https://nodejs.org/en/download/) (version 16 or higher) if it
is not already installed on your machine.

## Install LoopBack 4 CLI
Expand All @@ -30,6 +30,9 @@ The CLI tool will scaffold the project, configure the TypeScript compiler, and
install all the required dependencies. To create a new project, run the CLI as
follows and answer the prompts.

> We also have a specific generator to generate LoopBack projects. Run
> `npm create loopback`
```sh
lb4 app
```
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectbindings.api_connect_spec_enhancer'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectbindings.api_connect_spec_enhancer.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectBindings](./apiconnect.apiconnectbindings.md) &gt; [API\_CONNECT\_SPEC\_ENHANCER](./apiconnect.apiconnectbindings.api_connect_spec_enhancer.md)
Expand All @@ -11,3 +20,4 @@ Strongly-typed binding key for ApiConnectSpecEnhancer
```typescript
API_CONNECT_SPEC_ENHANCER: BindingKey<ApiConnectSpecEnhancer>
```

10 changes: 10 additions & 0 deletions pages/en/lb4/apidocs/apiconnect.apiconnectbindings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectbindings'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectbindings.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectBindings](./apiconnect.apiconnectbindings.md)
Expand All @@ -16,3 +25,4 @@ export declare namespace ApiConnectBindings
| --- | --- |
| [API\_CONNECT\_SPEC\_ENHANCER](./apiconnect.apiconnectbindings.api_connect_spec_enhancer.md) | Strongly-typed binding key for ApiConnectSpecEnhancer |
10 changes: 10 additions & 0 deletions pages/en/lb4/apidocs/apiconnect.apiconnectcomponent.bindings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectcomponent.bindings'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectcomponent.bindings.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectComponent](./apiconnect.apiconnectcomponent.md) &gt; [bindings](./apiconnect.apiconnectcomponent.bindings.md)
Expand All @@ -9,3 +18,4 @@
```typescript
bindings: Binding[];
```

10 changes: 10 additions & 0 deletions pages/en/lb4/apidocs/apiconnect.apiconnectcomponent.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectcomponent'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectcomponent.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectComponent](./apiconnect.apiconnectcomponent.md)
Expand All @@ -17,3 +26,4 @@ export declare class ApiConnectComponent implements Component
| --- | --- | --- | --- |
| [bindings](./apiconnect.apiconnectcomponent.bindings.md) | | [Binding](./context.binding.md)<!-- -->\[\] | |
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectspecenhancer._constructor_'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectspecenhancer._constructor_.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectSpecEnhancer](./apiconnect.apiconnectspecenhancer.md) &gt; [(constructor)](./apiconnect.apiconnectspecenhancer._constructor_.md)
Expand All @@ -19,3 +28,4 @@ constructor(options: ApiConnectSpecOptions, appMetadata?: ApplicationMetadata);
| options | [ApiConnectSpecOptions](./apiconnect.apiconnectspecoptions.md) | |
| appMetadata | [ApplicationMetadata](./core.applicationmetadata.md) | _(Optional)_ |


10 changes: 10 additions & 0 deletions pages/en/lb4/apidocs/apiconnect.apiconnectspecenhancer.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectspecenhancer'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectspecenhancer.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectSpecEnhancer](./apiconnect.apiconnectspecenhancer.md)
Expand Down Expand Up @@ -31,3 +40,4 @@ export declare class ApiConnectSpecEnhancer implements OASEnhancer
| --- | --- | --- |
| [modifySpec(spec)](./apiconnect.apiconnectspecenhancer.modifyspec.md) | | |
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectspecenhancer.modifyspec'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectspecenhancer.modifyspec.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectSpecEnhancer](./apiconnect.apiconnectspecenhancer.md) &gt; [modifySpec](./apiconnect.apiconnectspecenhancer.modifyspec.md)
Expand All @@ -20,3 +29,4 @@ modifySpec(spec: OpenAPIObject): OpenAPIObject;

OpenAPIObject


10 changes: 10 additions & 0 deletions pages/en/lb4/apidocs/apiconnect.apiconnectspecenhancer.name.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectspecenhancer.name'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectspecenhancer.name.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectSpecEnhancer](./apiconnect.apiconnectspecenhancer.md) &gt; [name](./apiconnect.apiconnectspecenhancer.name.md)
Expand All @@ -9,3 +18,4 @@
```typescript
name: string;
```

10 changes: 10 additions & 0 deletions pages/en/lb4/apidocs/apiconnect.apiconnectspecoptions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: apiconnect.apiconnectspecoptions'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.apiconnectspecoptions.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md) &gt; [ApiConnectSpecOptions](./apiconnect.apiconnectspecoptions.md)
Expand All @@ -13,3 +22,4 @@ export type ApiConnectSpecOptions = {
targetUrl: string;
};
```

14 changes: 13 additions & 1 deletion pages/en/lb4/apidocs/apiconnect.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
---
lang: en
title: 'API docs: apiconnect'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect
permalink: /doc/en/lb4/apidocs.apiconnect.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/apiconnect](./apiconnect.md)

## apiconnect package
## apiconnect package

[@loopback/apiconnect](https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect)

## Classes

Expand All @@ -23,3 +34,4 @@
| --- | --- |
| [ApiConnectSpecOptions](./apiconnect.apiconnectspecoptions.md) | Configuration for IBM API Connect extensions to the OpenAPI spec |


10 changes: 10 additions & 0 deletions pages/en/lb4/apidocs/authentication-jwt.credentials.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.credentials'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.credentials.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [Credentials](./authentication-jwt.credentials.md)
Expand All @@ -14,3 +23,4 @@ export type Credentials = {
password: string;
};
```

Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationcomponent._constructor_'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationcomponent._constructor_.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationComponent](./authentication-jwt.jwtauthenticationcomponent.md) &gt; [(constructor)](./authentication-jwt.jwtauthenticationcomponent._constructor_.md)
Expand All @@ -18,3 +27,4 @@ constructor(app: Application);
| --- | --- | --- |
| app | [Application](./core.application.md) | |


Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationcomponent.bindings'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationcomponent.bindings.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationComponent](./authentication-jwt.jwtauthenticationcomponent.md) &gt; [bindings](./authentication-jwt.jwtauthenticationcomponent.bindings.md)
Expand All @@ -9,3 +18,4 @@
```typescript
bindings: Binding[];
```

Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationcomponent'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationcomponent.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationComponent](./authentication-jwt.jwtauthenticationcomponent.md)
Expand All @@ -23,3 +32,4 @@ export declare class JWTAuthenticationComponent implements Component
| --- | --- | --- | --- |
| [bindings](./authentication-jwt.jwtauthenticationcomponent.bindings.md) | | [Binding](./context.binding.md)<!-- -->\[\] | |
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationstrategy._constructor_'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationstrategy._constructor_.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationStrategy](./authentication-jwt.jwtauthenticationstrategy.md) &gt; [(constructor)](./authentication-jwt.jwtauthenticationstrategy._constructor_.md)
Expand All @@ -18,3 +27,4 @@ constructor(tokenService: TokenService);
| --- | --- | --- |
| tokenService | [TokenService](./authentication.tokenservice.md) | |


Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationstrategy.authenticate'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationstrategy.authenticate.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationStrategy](./authentication-jwt.jwtauthenticationstrategy.md) &gt; [authenticate](./authentication-jwt.jwtauthenticationstrategy.authenticate.md)
Expand All @@ -20,3 +29,4 @@ authenticate(request: Request): Promise<UserProfile | undefined>;

Promise&lt;[UserProfile](./security.userprofile.md) \| undefined&gt;


Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationstrategy.extractcredentials'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationstrategy.extractcredentials.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationStrategy](./authentication-jwt.jwtauthenticationstrategy.md) &gt; [extractCredentials](./authentication-jwt.jwtauthenticationstrategy.extractcredentials.md)
Expand All @@ -20,3 +29,4 @@ extractCredentials(request: Request): string;

string


Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationstrategy'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationstrategy.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationStrategy](./authentication-jwt.jwtauthenticationstrategy.md)
Expand Down Expand Up @@ -31,3 +40,4 @@ export declare class JWTAuthenticationStrategy implements AuthenticationStrategy
| [authenticate(request)](./authentication-jwt.jwtauthenticationstrategy.authenticate.md) | | |
| [extractCredentials(request)](./authentication-jwt.jwtauthenticationstrategy.extractcredentials.md) | | |
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationstrategy.name'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationstrategy.name.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationStrategy](./authentication-jwt.jwtauthenticationstrategy.md) &gt; [name](./authentication-jwt.jwtauthenticationstrategy.name.md)
Expand All @@ -9,3 +18,4 @@
```typescript
name: string;
```

Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
lang: en
title: 'API docs: authentication-jwt.jwtauthenticationstrategy.tokenservice'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.jwtauthenticationstrategy.tokenservice.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/authentication-jwt](./authentication-jwt.md) &gt; [JWTAuthenticationStrategy](./authentication-jwt.jwtauthenticationstrategy.md) &gt; [tokenService](./authentication-jwt.jwtauthenticationstrategy.tokenservice.md)
Expand All @@ -9,3 +18,4 @@
```typescript
tokenService: TokenService;
```

Loading

0 comments on commit 86c839d

Please sign in to comment.