@digitalpersona/devices
Version:
DigitalPersona Security Devices support library
1,546 lines • 176 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.2.2",
"schemaVersion": 1001,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@digitalpersona/devices",
"docComment": "",
"name": "@digitalpersona/devices",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Class",
"canonicalReference": "(AcquisitionStarted:class)",
"docComment": "/**\n * An event signaling that a fingerprint reader is ready and waiting to scan a finger.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "AcquisitionStarted"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "DeviceEvent"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "AcquisitionStarted",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new event object.\n *\n * @param deviceUid - a fingeprint reader ID.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "deviceUid"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "deviceUid",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(AcquisitionStopped:class)",
"docComment": "/**\n * An event signaling that a fingerprint reader has stopped waiting for a finger scan.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "AcquisitionStopped"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "DeviceEvent"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "AcquisitionStopped",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new event object.\n *\n * @param deviceUid - a fingeprint reader ID.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "deviceUid"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "deviceUid",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(Card:interface)",
"docComment": "/**\n * A card information.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Card"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Card",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "Attributes",
"docComment": "/**\n * Attributes supported by the card.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "Attributes"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "CardAttributes"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Attributes",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "Name",
"docComment": "/**\n * A card name.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "Name"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Name",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "Reader",
"docComment": "/**\n * A card reader name.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "Reader"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Reader",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "Type",
"docComment": "/**\n * A card type.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "Type"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "CardType"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Type",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Enum",
"canonicalReference": "(CardAttributes:enum)",
"docComment": "/**\n * Bitwise flags for attributes supported by a card.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare enum "
},
{
"kind": "Reference",
"text": "CardAttributes"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "CardAttributes",
"members": [
{
"kind": "EnumMember",
"canonicalReference": "IsPIV",
"docComment": "/**\n * The card supports PIV.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "IsPIV"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "131072"
}
],
"releaseTag": "Public",
"name": "IsPIV",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "IsPKI",
"docComment": "/**\n * The card supports PKI.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "IsPKI"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "65536"
}
],
"releaseTag": "Public",
"name": "IsPKI",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "IsReadOnly",
"docComment": "/**\n * The card is read-only.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "IsReadOnly"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "2147483648"
}
],
"releaseTag": "Public",
"name": "IsReadOnly",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "SupportsPIN",
"docComment": "/**\n * The card supports PIN code.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "SupportsPIN"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "1"
}
],
"releaseTag": "Public",
"name": "SupportsPIN",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "SupportsUID",
"docComment": "/**\n * The card supports UID.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "SupportsUID"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "2"
}
],
"releaseTag": "Public",
"name": "SupportsUID",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
]
},
{
"kind": "Class",
"canonicalReference": "(CardInserted:class)",
"docComment": "/**\n * An event signaling that a card was presented (inserted or touched) to a card reader.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "CardInserted"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "DeviceEvent"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "CardInserted",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Contructs a new event object.\n *\n * @param reader - a name of a card reader where the card was presented.\n *\n * @param card - a name of a card presented.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "reader"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "card"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "reader",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "card",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
]
},
{
"kind": "Property",
"canonicalReference": "(cardId:instance)",
"docComment": "/**\n * A card ID\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "cardId"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "cardId",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(CardRemoved:class)",
"docComment": "/**\n * An event signaling that a card was removed from a card reader.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "CardRemoved"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "DeviceEvent"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "CardRemoved",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Contructs a new event object.\n *\n * @param reader - a name of a card reader where the card was presented.\n *\n * @param card - a name of a card presented.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "reader"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "card"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "reader",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "card",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
]
},
{
"kind": "Property",
"canonicalReference": "(cardId:instance)",
"docComment": "/**\n * A card ID\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "cardId"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "cardId",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(CardsReader:class)",
"docComment": "/**\n * A card reader API class. An instance of this class allows to subscribe to card reader events and read card data. The card reader API uses DigitalPersona WebSDK to communicate with card reader drivers and hardware.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "CardsReader"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "MultiCastEventSource"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "CardsReader",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new card reader API object.\n *\n * @param options - options for the `WebSdk` channel.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "WebSdk"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "WebChannelOptions"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(enumerateCards:instance,0)",
"docComment": "/**\n * Lists all inserted cards.\n *\n * @returns a promise to return a list of card information for connected cards.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "enumerateCards"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Card"
},
{
"kind": "Content",
"text": "[]>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "enumerateCards"
},
{
"kind": "Method",
"canonicalReference": "(enumerateReaders:instance,0)",
"docComment": "/**\n * Lists all connected card readers.\n *\n * @returns a promise to return a list of card reader names.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "enumerateReaders"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<string[]>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "enumerateReaders"
},
{
"kind": "Method",
"canonicalReference": "(getCardAuthData:instance,0)",
"docComment": "/**\n * Reads card authentication data.\n *\n * @param reader - a name of a card reader where the card was presented.\n *\n * @param pin - an PIN code (for cards requiring a PIN).\n *\n * @returns a promise to return card authentication data. The card data is an opaque encoded string which should be sent to the server as is.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getCardAuthData"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "reader"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "pin"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "reader",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "pin",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "getCardAuthData"
},
{
"kind": "Method",
"canonicalReference": "(getCardEnrollData:instance,0)",
"docComment": "/**\n * Reads card enrollment data.\n *\n * @param reader - a name of a card reader where the card was presented.\n *\n * @param pin - an PIN code (for cards requiring a PIN).\n *\n * @returns a promise to return a card enrollment data. The card data is an opaque encoded string which should be sent to the server as is.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getCardEnrollData"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "reader"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "pin"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "reader",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "pin",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "getCardEnrollData"
},
{
"kind": "Method",
"canonicalReference": "(getCardInfo:instance,0)",
"docComment": "/**\n * Reads card data from a specific card.\n *\n * @param reader - a name of a card reader where the card was presented.\n *\n * @returns a promise to return a card information. The promise can be fulfilled but return `null` if the card has no information. The promise will be rejected if a card is not found or in case of a reading error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getCardInfo"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "reader"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Card"
},
{
"kind": "Content",
"text": " | null>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "reader",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "getCardInfo"
},
{
"kind": "Method",
"canonicalReference": "(getCardUid:instance,0)",
"docComment": "/**\n * Reads a card unique identifier.\n *\n * @param reader - a name of a card reader where the card was presented.\n *\n * @returns a promise to return a card identifier.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getCardUid"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "reader"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "reader",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "getCardUid"
},
{
"kind": "Method",
"canonicalReference": "(off:instance,0)",
"docComment": "/**\n * Deletes an event handler for the event.\n *\n * @param event - a name of the event to subscribe.\n *\n * @param handler - an event handler added with the {@link CardsReader.on} method.\n *\n * @example\n *\n * See example in {@link CardsReader.on}\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "off"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "E"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Event"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "handler"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Handler"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "E"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "this"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 17,
"endIndex": 18
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
},
{
"parameterName": "handler",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 16
}
}
],
"typeParameters": [
{
"typeParameterName": "E",
"constraintTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "off"
},
{
"kind": "Method",
"canonicalReference": "(on:instance,0)",
"docComment": "/**\n * Adds an event handler for the event. This is a multicast subscription, i.e. many handlers can be registered at once.\n *\n * @param event - a name of the event to subscribe, e.g. \"CardInserted\"\n *\n * @param handler - an event handler.\n *\n * @returns an event handler reference. Store the reference and pass it to the {@link CardsReader.off} to unsubscribe from the event.\n *\n * @example\n * ```\n * class CardComponent\n * {\n * private reader: CardsReader;\n *\n * private onCardInserted = (event: CardInserted) => { ... }\n * private onCardRemoved = (event: CardRemoved) => { ... }\n * ...\n *\n * public async $onInit() {\n * this.reader = new CardsReader();\n * this.reader.on(\"CardInserted\", this.onCardInserted);\n * this.reader.on(\"CardRemoved\", this.onCardRemoved);\n * ...\n * await this.cardReader.subscribe()\n * }\n * public async $onDestroy() {\n * await this.cardReader.unsubscribe();\n * this.reader.off(\"CardInserted\", this.onCardInserted);\n * this.reader.off(\"CardRemoved\", this.onCardRemoved);\n * ...\n * // alternatively, call this.reader.off() to unsubscribe from all events at once.\n * delete this.reader;\n * }\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "on"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "E"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Event"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "handler"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Handler"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "E"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Handler"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "E"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 17,
"endIndex": 21
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
},
{
"parameterName": "handler",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 16
}
}
],
"typeParameters": [
{
"typeParameterName": "E",
"constraintTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "on"
},
{
"kind": "Property",
"canonicalReference": "(onCardInserted:instance)",
"docComment": "/**\n * An event handler for the {@link CardInserted} event. This is a unicast subscription, i.e. only one handler can be registered at once.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onCardInserted"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Handler"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "CardInserted"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "onCardInserted",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(onCardRemoved:instance)",
"docComment": "/**\n * An event handler for the {@link CardRemoved} event. This is a unicast subscription, i.e. only one handler can be registered at once.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onCardRemoved"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Handler"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "CardRemoved"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "onCardRemoved",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(onCommunicationFailed:instance)",
"docComment": "/**\n * An event handler for the {@link CommunicationFailed} event. This is a unicast subscription, i.e. only one handler can be registered at once.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onCommunicationFailed"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Handler"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "CommunicationFailed"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "onCommunicationFailed",
"propertyTypeTokenRange": {
"s