Class GeoPackageCache

GeoPackage Cache

Hierarchy

GeoPackageCache

Index

Constructors

constructor

new GeoPackageCache(): GeoPackageCache
Returns GeoPackageCache

Methods

add

add(geoPackage: GeoPackage): void
Add a GeoPackage to the cache
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns void
- Defined in lib/geoPackageCache.ts:138

addAll

addAll(geoPackages: GeoPackage[]): void
Add the collection of GeoPackages
Parameters
- geoPackages: GeoPackage[]
  
  GeoPackages
Returns void
- Defined in lib/geoPackageCache.ts:146

clear

clear(): void
Clears all cached GeoPackages but does not close them, call #closeAll() to close and clear all GeoPackages

Returns void
- Defined in lib/geoPackageCache.ts:170

close

close(geoPackage: GeoPackage): void
Close the GeoPackage
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns void
- Defined in lib/geoPackageCache.ts:221

closeAll

closeAll(): void
Close all GeoPackages in the cache

Returns void
- Defined in lib/geoPackageCache.ts:125

closeIfCached

closeIfCached(geoPackage: GeoPackage): boolean
Close the GeoPackage if it is cached (same GeoPackage instance)

Returns
true if closed
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns boolean
- Defined in lib/geoPackageCache.ts:240

closeIfNotCached

closeIfNotCached(geoPackage: GeoPackage): boolean
Close the GeoPackage if it is not cached (GeoPackage not cached or different instance)

Returns
true if closed
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns boolean
- Defined in lib/geoPackageCache.ts:259

closeRetain

closeRetain(retain: string[]): void
Close GeoPackages not specified in the retain GeoPackage names
Parameters
- retain: string[]
  
  GeoPackages to retain
Returns void
- Defined in lib/geoPackageCache.ts:202

closeWithName

closeWithName(name: string): boolean
Close the GeoPackage with name

Returns
true if found and closed
Parameters
- name: string
  
  GeoPackage name
Returns boolean
- Defined in lib/geoPackageCache.ts:190

closeWithNames

closeWithNames(names: string[]): void
Close GeoPackages with names
Parameters
- names: string[]
  
  GeoPackage names
Returns void
- Defined in lib/geoPackageCache.ts:211

exists

exists(name: string): boolean
Checks if the GeoPackage name exists in the cache

Returns
true if exists
Parameters
- name: string
  
  GeoPackage name
Returns boolean
- Defined in lib/geoPackageCache.ts:118

get

get(name: string): GeoPackage
Get the GeoPackage with name

Returns
cached GeoPackage
Parameters
- name: string
  
  GeoPackage name
Returns GeoPackage
- Defined in lib/geoPackageCache.ts:107

getGeoPackages

getGeoPackages(): GeoPackage[]
Get the cached GeoPackages

Returns
collection of cached GeoPackages

Returns GeoPackage[]
- Defined in lib/geoPackageCache.ts:85

getNames

getNames(): string[]
Get the names of the cached GeoPackages

Returns
set of cached GeoPackage names

Returns string[]
- Defined in lib/geoPackageCache.ts:76

getOrNoCacheOpen

getOrNoCacheOpen(gppathOrByteArray: string | Buffer | Uint8Array): Promise<GeoPackage>
Get the cached GeoPackage or open the GeoPackage file without caching it

Returns
GeoPackage
Parameters
- gppathOrByteArray: string | Buffer | Uint8Array
  
  GeoPackage buffer, Uint8Array or filePath
Returns Promise<GeoPackage>
- Defined in lib/geoPackageCache.ts:24

has

has(name: string): boolean
Determine if the cache has the GeoPackage name

Returns
true if has cached GeoPackage
Parameters
- name: string
  
  GeoPackage name
Returns boolean
- Defined in lib/geoPackageCache.ts:96

isCloseQuietly

isCloseQuietly(): boolean
Is close quietly mode enabled

Returns
true if close quiet mode

Returns boolean
- Defined in lib/geoPackageCache.ts:59

remove

remove(name: string): GeoPackage
Remove the GeoPackage with the name but does not close it, call #close(String) to close and remove

Returns
removed GeoPackage
Parameters
- name: string
  
  GeoPackage name
Returns GeoPackage
- Defined in lib/geoPackageCache.ts:160

removeAndClose

removeAndClose(name: string): boolean
Remove and close the GeoPackage with name, same as #close(String)

Returns
true if found, removed, and closed
Parameters
- name: string
  
  GeoPackage name
Returns boolean
- Defined in lib/geoPackageCache.ts:181

setCloseQuietly

setCloseQuietly(closeQuietly: boolean): void
Set the close quietly mode
Parameters
- closeQuietly: boolean
  
  true to close quietly
Returns void
- Defined in lib/geoPackageCache.ts:67

Generated using TypeDoc