Class GeoPackageManager

GeoPackage Manager used to create and open GeoPackages

Hierarchy

GeoPackageManager

Index

Constructors

Properties

Methods

connect connectWithDatabase create open

Constructors

constructor

new GeoPackageManager(): GeoPackageManager
Returns GeoPackageManager

Properties

`Static` `Readonly` version

version: string = '5.0.0'

Methods

`Static` connect

connect(filePath: string | Buffer | Uint8Array): Promise<GeoPackageConnection>
Connects to the database and returns a GeoPackageConnection
Parameters
- filePath: string | Buffer | Uint8Array
Returns Promise<GeoPackageConnection>
- Defined in lib/geoPackageManager.ts:103

`Static` connectWithDatabase

connectWithDatabase(db: DBAdapter): Promise<GeoPackageConnection>
Creates a GeoPackageConnection with an existing database adapter
Parameters
- db: DBAdapter
Returns Promise<GeoPackageConnection>
- Defined in lib/geoPackageManager.ts:118

`Static` create

create(gppath?: string, name?: string): Promise<GeoPackage>
In Node, create a GeoPackage file at the given file path, or in a browser, create an in-memory GeoPackage.

Returns
promise that resolves with the open GeoPackage object or rejects with an Error
Parameters
- Optional gppath: string
  
  path of the created GeoPackage file; ignored in the browser
- Optional name: string
  
  name for the GeoPackage
Returns Promise<GeoPackage>
- Defined in lib/geoPackageManager.ts:58

`Static` open

open(gppathOrByteArray: string | Buffer | Uint8Array, name?: string): Promise<GeoPackage>
In Node, open a GeoPackage file at the given path, or in a browser, load an in-memory GeoPackage from the given byte array.

Returns
promise that resolves with the open GeoPackage object or rejects with an Error
Parameters
- gppathOrByteArray: string | Buffer | Uint8Array
  
  path to the GeoPackage file or Uint8Array of GeoPackage bytes
- name: string = undefined
  
  name of GeoPackage, but defaults to file path in Node
Returns Promise<GeoPackage>
- Defined in lib/geoPackageManager.ts:23

Generated using TypeDoc