blockstack
Version:
The Blockstack Javascript library for identity and authentication.
2,086 lines (2,085 loc) • 233 kB
JSON
[
{
"name": "Authentication",
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Single sign on and authentication without third parties or remote servers.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 75,
"offset": 74
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 75,
"offset": 74
},
"indent": []
}
},
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "https://github.com/blockstack/blockstack.js/blob/master/src/auth/README.md",
"children": [
{
"type": "text",
"value": "Read more about authentication",
"position": {
"start": {
"line": 3,
"column": 2,
"offset": 77
},
"end": {
"line": 3,
"column": 32,
"offset": 107
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 76
},
"end": {
"line": 3,
"column": 109,
"offset": 184
},
"indent": []
}
}
],
"position": {
"start": {
"line": 3,
"column": 1,
"offset": 76
},
"end": {
"line": 3,
"column": 109,
"offset": 184
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 4,
"column": 1,
"offset": 185
}
}
},
"kind": "note",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "Authentication",
"kind": "note"
}
],
"namespace": "Authentication"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Generates an authentication request and redirects the user to the Blockstack\nbrowser to approve the sign in request.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 40,
"offset": 116
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 40,
"offset": 116
},
"indent": [
1
]
}
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Please note that this requires that the web browser properly handles the\n",
"position": {
"start": {
"line": 4,
"column": 1,
"offset": 118
},
"end": {
"line": 5,
"column": 1,
"offset": 191
},
"indent": [
1
]
}
},
{
"type": "inlineCode",
"value": "blockstack:",
"position": {
"start": {
"line": 5,
"column": 1,
"offset": 191
},
"end": {
"line": 5,
"column": 14,
"offset": 204
},
"indent": []
}
},
{
"type": "text",
"value": " URL protocol handler.",
"position": {
"start": {
"line": 5,
"column": 14,
"offset": 204
},
"end": {
"line": 5,
"column": 36,
"offset": 226
},
"indent": []
}
}
],
"position": {
"start": {
"line": 4,
"column": 1,
"offset": 118
},
"end": {
"line": 5,
"column": 36,
"offset": 226
},
"indent": [
1
]
}
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Most applications should use this\nmethod for sign in unless they require more fine grained control over how the\nauthentication request is generated. If your app falls into this category,\nuse ",
"position": {
"start": {
"line": 7,
"column": 1,
"offset": 228
},
"end": {
"line": 10,
"column": 5,
"offset": 419
},
"indent": [
1,
1,
1
]
}
},
{
"type": "inlineCode",
"value": "generateAndStoreTransitKey",
"position": {
"start": {
"line": 10,
"column": 5,
"offset": 419
},
"end": {
"line": 10,
"column": 33,
"offset": 447
},
"indent": []
}
},
{
"type": "text",
"value": ", ",
"position": {
"start": {
"line": 10,
"column": 33,
"offset": 447
},
"end": {
"line": 10,
"column": 35,
"offset": 449
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "makeAuthRequest",
"position": {
"start": {
"line": 10,
"column": 35,
"offset": 449
},
"end": {
"line": 10,
"column": 52,
"offset": 466
},
"indent": []
}
},
{
"type": "text",
"value": ",\nand ",
"position": {
"start": {
"line": 10,
"column": 52,
"offset": 466
},
"end": {
"line": 11,
"column": 5,
"offset": 472
},
"indent": [
1
]
}
},
{
"type": "inlineCode",
"value": "redirectToSignInWithAuthRequest",
"position": {
"start": {
"line": 11,
"column": 5,
"offset": 472
},
"end": {
"line": 11,
"column": 38,
"offset": 505
},
"indent": []
}
},
{
"type": "text",
"value": " to build your own sign in process.",
"position": {
"start": {
"line": 11,
"column": 38,
"offset": 505
},
"end": {
"line": 11,
"column": 73,
"offset": 540
},
"indent": []
}
}
],
"position": {
"start": {
"line": 7,
"column": 1,
"offset": 228
},
"end": {
"line": 11,
"column": 73,
"offset": 540
},
"indent": [
1,
1,
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 11,
"column": 73,
"offset": 540
}
}
},
"tags": [
{
"title": "param",
"description": "The location to which the identity provider will redirect the user after\nthe user approves sign in.",
"lineNumber": 13,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "String"
}
},
"name": "redirectURI",
"default": "`${window.location.origin}/`"
},
{
"title": "param",
"description": "Location of the manifest file.",
"lineNumber": 16,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "String"
}
},
"name": "manifestURI",
"default": "`${window.location.origin}/manifest.json`"
},
{
"title": "param",
"description": "Defaults to requesting write access to\nthis app's data store.\nAn array of strings indicating which permissions this app is requesting.",
"lineNumber": 18,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "Array"
}
},
"name": "scopes",
"default": "DEFAULT_SCOPE"
},
{
"title": "return",
"description": null,
"lineNumber": 21,
"type": {
"type": "NameExpression",
"name": "void"
}
}
],
"loc": {
"start": {
"line": 87,
"column": 0
},
"end": {
"line": 109,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 110,
"column": 0
},
"end": {
"line": 116,
"column": 1
}
},
"file": "/Users/larry/git/blockstack.js/src/auth/authApp.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "redirectURI",
"lineNumber": 13,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "The location to which the identity provider will redirect the user after\nthe user approves sign in.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 27,
"offset": 99
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 27,
"offset": 99
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 27,
"offset": 99
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
},
"default": "`${window.location.origin}/`"
},
{
"title": "param",
"name": "manifestURI",
"lineNumber": 16,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Location of the manifest file.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 31,
"offset": 30
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 31,
"offset": 30
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 31,
"offset": 30
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
},
"default": "`${window.location.origin}/manifest.json`"
},
{
"title": "param",
"name": "scopes",
"lineNumber": 18,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Defaults to requesting write access to\nthis app's data store.\nAn array of strings indicating which permissions this app is requesting.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 73,
"offset": 134
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 73,
"offset": 134
},
"indent": [
1,
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 3,
"column": 73,
"offset": 134
}
}
},
"type": {
"type": "NameExpression",
"name": "Array"
},
"default": "DEFAULT_SCOPE"
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 1,
"offset": 0
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "void"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "redirectToSignIn",
"kind": "function",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "redirectToSignIn",
"kind": "function"
}
],
"namespace": "redirectToSignIn"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Check if there is a authentication request that hasn't been handled.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 69,
"offset": 68
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 69,
"offset": 68
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 69,
"offset": 68
}
}
},
"tags": [
{
"title": "return",
"description": "`true` if there is a pending sign in, otherwise `false`",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Boolean"
}
}
],
"loc": {
"start": {
"line": 127,
"column": 0
},
"end": {
"line": 130,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 131,
"column": 0
},
"end": {
"line": 133,
"column": 1
}
},
"file": "/Users/larry/git/blockstack.js/src/auth/authApp.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "true",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 7,
"offset": 6
},
"indent": []
}
},
{
"type": "text",
"value": " if there is a pending sign in, otherwise ",
"position": {
"start": {
"line": 1,
"column": 7,
"offset": 6
},
"end": {
"line": 1,
"column": 49,
"offset": 48
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "false",
"position": {
"start": {
"line": 1,
"column": 49,
"offset": 48
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 56,
"offset": 55
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Boolean"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "isSignInPending",
"kind": "function",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "isSignInPending",
"kind": "function"
}
],
"namespace": "isSignInPending"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Try to process any pending sign in request by returning a ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 59,
"offset": 58
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "Promise",
"position": {
"start": {
"line": 1,
"column": 59,
"offset": 58
},
"end": {
"line": 1,
"column": 68,
"offset": 67
},
"indent": []
}
},
{
"type": "text",
"value": " that resolves\nto the user data object if the sign in succeeds.",
"position": {
"start": {
"line": 1,
"column": 68,
"offset": 67
},
"end": {
"line": 2,
"column": 49,
"offset": 130
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 49,
"offset": 130
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 49,
"offset": 130
}
}
},
"tags": [
{
"title": "param",
"description": "the endpoint against which to verify public\nkeys match claimed username",
"lineNumber": 4,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "nameLookupURL"
},
{
"title": "return",
"description": "that resolves to the user data object if successful and rejects\nif handling the sign in request fails or there was no pending sign in request.",
"lineNumber": 7,
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"loc": {
"start": {
"line": 136,
"column": 0
},
"end": {
"line": 145,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 146,
"column": 0
},
"end": {
"line": 224,
"column": 1
}
},
"file": "/Users/larry/git/blockstack.js/src/auth/authApp.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "nameLookupURL",
"lineNumber": 4,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "the endpoint against which to verify public\nkeys match claimed username",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 28,
"offset": 71
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 28,
"offset": 71
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 28,
"offset": 71
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
},
"default": "'https://core.blockstack.org/v1/names/'"
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "that resolves to the user data object if successful and rejects\nif handling the sign in request fails or there was no pending sign in request.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 79,
"offset": 142
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 79,
"offset": 142
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 79,
"offset": 142
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Promise"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "handlePendingSignIn",
"kind": "function",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "handlePendingSignIn",
"kind": "function"
}
],
"namespace": "handlePendingSignIn"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Retrieves the user data object. The user's profile is stored in the key ",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 73,
"offset": 72
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "profile",
"position": {
"start": {
"line": 1,
"column": 73,
"offset": 72
},
"end": {
"line": 1,
"column": 82,
"offset": 81
},
"indent": []
}
},
{
"type": "text",
"value": ".",
"position": {
"start": {
"line": 1,
"column": 82,
"offset": 81
},
"end": {
"line": 1,
"column": 83,
"offset": 82
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 83,
"offset": 82
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 83,
"offset": 82
}
}
},
"tags": [
{
"title": "return",
"description": "User data object.",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"loc": {
"start": {
"line": 226,
"column": 0
},
"end": {
"line": 229,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 230,
"column": 0
},
"end": {
"line": 232,
"column": 1
}
},
"file": "/Users/larry/git/blockstack.js/src/auth/authApp.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "User data object.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 18,
"offset": 17
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Object"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "loadUserData",
"kind": "function",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "loadUserData",
"kind": "function"
}
],
"namespace": "loadUserData"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Check if a user is currently signed in.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 40,
"offset": 39
}
}
},
"tags": [
{
"title": "return",
"description": "`true` if the user is signed in, `false` if not.",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Boolean"
}
}
],
"loc": {
"start": {
"line": 45,
"column": 0
},
"end": {
"line": 48,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 49,
"column": 0
},
"end": {
"line": 51,
"column": 1
}
},
"file": "/Users/larry/git/blockstack.js/src/auth/authApp.js"
},
"augments": [],
"examples": [],
"params": [],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "true",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 7,
"offset": 6
},
"indent": []
}
},
{
"type": "text",
"value": " if the user is signed in, ",
"position": {
"start": {
"line": 1,
"column": 7,
"offset": 6
},
"end": {
"line": 1,
"column": 34,
"offset": 33
},
"indent": []
}
},
{
"type": "inlineCode",
"value": "false",
"position": {
"start": {
"line": 1,
"column": 34,
"offset": 33
},
"end": {
"line": 1,
"column": 41,
"offset": 40
},
"indent": []
}
},
{
"type": "text",
"value": " if not.",
"position": {
"start": {
"line": 1,
"column": 41,
"offset": 40
},
"end": {
"line": 1,
"column": 49,
"offset": 48
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 49,
"offset": 48
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 49,
"offset": 48
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "Boolean"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "isUserSignedIn",
"kind": "function",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "isUserSignedIn",
"kind": "function"
}
],
"namespace": "isUserSignedIn"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Sign the user out and optionally redirect to given location.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 61,
"offset": 60
}
}
},
"tags": [
{
"title": "param",
"description": "Location to redirect user to after sign out.",
"lineNumber": 2,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "String"
}
},
"name": "redirectURL",
"default": "null"
},
{
"title": "return",
"description": null,
"lineNumber": 3,
"type": {
"type": "NameExpression",
"name": "void"
}
}
],
"loc": {
"start": {
"line": 234,
"column": 0
},
"end": {
"line": 238,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 239,
"column": 0
},
"end": {
"line": 246,
"column": 1
}
},
"file": "/Users/larry/git/blockstack.js/src/auth/authApp.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "redirectURL",
"lineNumber": 2,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Location to redirect user to after sign out.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 45,
"offset": 44
}
}
},
"type": {
"type": "NameExpression",
"name": "String"
},
"default": "null"
}
],
"properties": [],
"returns": [
{
"description": {
"type": "root",
"children": [],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 1,
"column": 1,
"offset": 0
}
}
},
"title": "returns",
"type": {
"type": "NameExpression",
"name": "void"
}
}
],
"sees": [],
"throws": [],
"todos": [],
"name": "signUserOut",
"kind": "function",
"members": {
"global": [],
"inner": [],
"instance": [],
"events": [],
"static": []
},
"path": [
{
"name": "signUserOut",
"kind": "function"
}
],
"namespace": "signUserOut"
},
{
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Generates an authentication request that can be sent to the Blockstack\nbrowser for the user to approve sign in.",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 41,
"offset": 111
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 41,
"offset": 111
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 41,
"offset": 111
}
}
},
"tags": [
{
"title": "param",
"description": "hex encoded transit\n private key",
"lineNumber": 3,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "String"
}
},
"name": "transitPrivateKey",
"default": "generateAndStoreTransitKey()"
},
{
"title": "param",
"description": "location to redirect user to after sign in approval",
"lineNumber": 5,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "redirectURI"
},
{
"title": "param",
"description": "location of this app's manifest file",
"lineNumber": 6,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "manifestURI"
},
{
"title": "param",
"description": "the permissions this app is requesting",
"lineNumber": 7,
"type": {
"type": "TypeApplication",
"expression": {
"type": "NameExpression",
"name": "Array"
},
"applications": [
{
"type": "NameExpression",
"name": "String"
}
]
},
"name": "scopes"
},
{
"title": "param",
"description": "the origin of this app",
"lineNumber": 8,
"type": {
"type": "NameExpression",
"name": "String"
},
"name": "appDomain"
},
{
"title": "param",
"description": "the time at which this request is no longer valid",
"lineNumber": 9,
"type": {
"type": "NameExpression",
"name": "Number"
},
"name": "expiresAt"
},
{
"title": "return",
"description": "the authentication request",
"lineNumber": 10,
"type": {
"type": "NameExpression",
"name": "String"
}
}
],
"loc": {
"start": {
"line": 27,
"column": 0
},
"end": {
"line": 38,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 39,
"column": 0
},
"end": {
"line": 74,
"column": 1
}
},
"file": "/Users/larry/git/blockstack.js/src/auth/authMessages.js"
},
"augments": [],
"examples": [],
"params": [
{
"title": "param",
"name": "transitPrivateKey",
"lineNumber": 3,
"description": {
"type": "root",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "hex encoded transit\n private key",
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 14,
"offset": 33
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},
"end": {
"line": 2,
"column": 14,
"offset": 33
},
"indent": [
1
]
}
}
],
"position": {
"start": {
"line": 1,
"column": 1,
"offset": 0
},