Class Harpee

Hierarchy

HarpeeHttp
Hierarchy
- Harpee

Index

Constructors

Properties

Logger Model Schema Sqler Utilities _schemaConfig

Methods

connect createConnection

Constructors

constructor

new Harpee(): Harpee
Returns Harpee
Inherited from HarpeeHttp.constructor
- Defined in core/harpee-http.ts:16

Properties

`Static` Logger

Logger: typeof HarpeeLogger = HarpeeLogger

`Static` Model

Model: typeof HarpeeModel = HarpeeModel

`Static` Schema

Schema: typeof HarpeeSchema = HarpeeSchema

`Static` Sqler

Sqler: typeof SqlHandler = SqlHandler

`Static` Utilities

Utilities: typeof HarpeeUtilities = HarpeeUtilities

`Static` _schemaConfig

_schemaConfig: IHarpeeSchemaConfig

Methods

`Static` connect

connect(config: IHarpeeAuthConfig, connectionInfo?: HarpeeConnectInfoCallback): void | { host: string; pass?: string; password?: string; token?: string; user?: string; username?: string }
Alias for createConnection.
Parameters
- config: IHarpeeAuthConfig
- Optional connectionInfo: HarpeeConnectInfoCallback
Returns void | { host: string; pass?: string; password?: string; token?: string; user?: string; username?: string }
- Defined in core/index.ts:54

`Static` createConnection

createConnection(config: IHarpeeAuthConfig, connectionCb?: HarpeeConnectInfoCallback): void | { host: string; pass?: string; password?: string; token?: string; user?: string; username?: string }
creates a connection to your harperDB instance
Parameters
- config: IHarpeeAuthConfig
- Optional connectionCb: HarpeeConnectInfoCallback
Returns void | { host: string; pass?: string; password?: string; token?: string; user?: string; username?: string }
- Defined in core/index.ts:19