Class BulletinData

Wrapper class for bulletin board dataset

Hierarchy

  • BulletinData

Constructors

constructor

Properties

distribution hasValidSource infoRecords infoRecordsLoaded iri loadError name provider source

Methods

checkRecommendedProperties fetchDistribution getDistribution getInfoRecords

Constructors

constructor

Properties

Private distribution

distribution: null | BulletinDistribution

hasValidSource

hasValidSource: boolean

Indicator that the distribtion is downloadable

Private infoRecords

infoRecords: InfoRecord[]

Private infoRecordsLoaded

infoRecordsLoaded: boolean

iri

iri: string

Bulletin dataset IRI

loadError

loadError: Error

Error from distribution download

name

name: string

Bulletin dataset name

provider

provider: Provider

Bulletin dataset provider

source

source: string

Download URL of dataset distribution

Methods

checkRecommendedProperties

fetchDistribution

  • Fetch distribution from source

    Returns

    Promise

    Parameters

    • Optional timeOut: number

    Returns Promise<void>

getDistribution

  • Get distribution fetchDistribution should be called before calling this

    Returns

    BulletinDistribution distribution, if it is fetched, otherwise null

    Returns null | BulletinDistribution

getInfoRecords

  • Returns a list of information records from the bulletin fetchDistribution should be called before calling this

    Returns

    Array

    Returns null | InfoRecord[]

Settings

Member Visibility

Theme

Generated using TypeDoc