@loopback/docs
Version:
Documentation for LoopBack 4
216 lines (215 loc) • 7.55 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.7.10",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/authentication-passport!",
"docComment": "",
"name": "@loopback/authentication-passport",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/authentication-passport!",
"name": "",
"members": [
{
"kind": "Class",
"canonicalReference": "@loopback/authentication-passport!StrategyAdapter:class",
"docComment": "/**\n * Adapter class to invoke passport-strategy 1. provides express dependencies to the passport strategies 2. provides shimming of requests for passport authentication 3. provides life-cycle similar to express to the passport-strategy 4. provides state methods to the strategy instance see: https://github.com/jaredhanson/passport\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class StrategyAdapter<U> implements "
},
{
"kind": "Reference",
"text": "AuthenticationStrategy",
"canonicalReference": "@loopback/authentication!AuthenticationStrategy:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "U",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "StrategyAdapter",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/authentication-passport!StrategyAdapter:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `StrategyAdapter` class\n *\n * @param - strategy instance of a class which implements a passport-strategy; @description http://passportjs.org/\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(strategy: "
},
{
"kind": "Reference",
"text": "Strategy",
"canonicalReference": "@types/passport!~passport.PassportStatic#Strategy:interface"
},
{
"kind": "Content",
"text": ", name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", userProfileFactory?: "
},
{
"kind": "Reference",
"text": "UserProfileFactory",
"canonicalReference": "@loopback/authentication!UserProfileFactory:interface"
},
{
"kind": "Content",
"text": "<U>"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "strategy",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "userProfileFactory",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
}
]
},
{
"kind": "Method",
"canonicalReference": "@loopback/authentication-passport!StrategyAdapter#authenticate:member(1)",
"docComment": "/**\n * The function to invoke the contained passport strategy. 1. Create an instance of the strategy 2. add success and failure state handlers 3. authenticate using the strategy\n *\n * @param - request The incoming request.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "authenticate(request: "
},
{
"kind": "Reference",
"text": "Request",
"canonicalReference": "@types/express!~e.Request:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "UserProfile",
"canonicalReference": "@loopback/security!UserProfile:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "request",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "authenticate"
},
{
"kind": "Property",
"canonicalReference": "@loopback/authentication-passport!StrategyAdapter#name:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
}
]
}
]
}