models.md

api › models

External module: models

Index

Classes

• KPBeacon
• KPEndNode
• KPMap
• KPNode
• KPSession
• KPStairsNode
• KPUser

Type aliases

• AddSessionCallback
• DeleteTimedOutSessionsCallback
• GenerateSessionCallback
• GetSessionCallback
• GetUserCallback
• RemoveSessionCallback
• SessionExistsCallback
• UseSessionCallback
• UserExistsCallback

Type aliases

AddSessionCallback

Ƭ AddSessionCallback: function

Defined in src/models/KPSession.ts:34

The callback for the KPSession.addSession method.

Type declaration:

▸ (err: Error): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.

---

DeleteTimedOutSessionsCallback

Ƭ DeleteTimedOutSessionsCallback: function

Defined in src/models/KPSession.ts:72

The callback for the KPSession.deleteTimedOutSessions method.

Type declaration:

▸ (err: Error): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.

---

GenerateSessionCallback

Ƭ GenerateSessionCallback: function

Defined in src/models/KPSession.ts:43

The callback for the KPSession.generateSession method.

Type declaration:

▸ (err: Error, sess: KPSession): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.
sess	KPSession	The generated session.

---

GetSessionCallback

Ƭ GetSessionCallback: function

Defined in src/models/KPSession.ts:15

The callback for the KPSession.getSession method.

Type declaration:

▸ (err: Error, sess: KPSession): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.
sess	KPSession	The target session.

---

GetUserCallback

Ƭ GetUserCallback: function

Defined in src/models/KPUser.ts:12

The callback for the KPUser.getUser method.

Type declaration:

▸ (err: Error, user: KPUser): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.
user	KPUser	The target user.

---

RemoveSessionCallback

Ƭ RemoveSessionCallback: function

Defined in src/models/KPSession.ts:25

The callback for the KPSession.removeSession method.

Type declaration:

▸ (err: Error): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.

---

SessionExistsCallback

Ƭ SessionExistsCallback: function

Defined in src/models/KPSession.ts:62

The callback for the KPSession.sessionExists method.

Type declaration:

▸ (err: Error, exists: boolean): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.
exists	boolean	Indicates whether or not a match was found.

---

UseSessionCallback

Ƭ UseSessionCallback: function

Defined in src/models/KPSession.ts:53

The callback for the KPSession.useSession method.

Type declaration:

▸ (err: Error): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.

---

UserExistsCallback

Ƭ UserExistsCallback: function

Defined in src/models/KPUser.ts:22

The callback for the KPUser.userExists method.

Type declaration:

▸ (err: Error, exists: boolean): void

Parameters:

Name	Type	Description
err	Error	If an error occurred, the callback will receive it here.
exists	boolean	Indicates whether or not a match was found.