Interface BsddSource

The port to bSDD. Every method resolves null / empty for "does not exist" and rejects on transport failure.

interface BsddSource {
    getClass(
        uri: string,
        options?: BsddClassOptions,
    ): Promise<BsddClass | null>;
    getDictionary(uri: string): Promise<BsddDictionary | null>;
    listClasses(dictionaryUri: string): Promise<BsddClassSummary[]>;
    listDictionaries(): Promise<BsddDictionary[]>;
    resolveUri(uri: string): Promise<BsddUriRecord>;
    searchClasses(query: BsddSearchQuery): Promise<BsddSearchPage>;
}

Hierarchy (View Summary)

BsddSource
- CachedBsddSource

Index

Methods

getClass getDictionary listClasses listDictionaries resolveUri searchClasses

Methods

getClass

getClass(uri: string, options?: BsddClassOptions): Promise<BsddClass | null>
Parameters
- uri: string
- Optionaloptions: BsddClassOptions
Returns Promise<BsddClass | null>

getDictionary

getDictionary(uri: string): Promise<BsddDictionary | null>
Parameters
- uri: string
Returns Promise<BsddDictionary | null>

listClasses

listClasses(dictionaryUri: string): Promise<BsddClassSummary[]>
Every class of a dictionary (flat; parentClassCode carries the tree).
Parameters
- dictionaryUri: string
Returns Promise<BsddClassSummary[]>

listDictionaries

listDictionaries(): Promise<BsddDictionary[]>

Returns Promise<BsddDictionary[]>

resolveUri

resolveUri(uri: string): Promise<BsddUriRecord>
Resolve any bSDD URI (class, property, dictionary) for URI health.
Parameters
- uri: string
Returns Promise<BsddUriRecord>

searchClasses

searchClasses(query: BsddSearchQuery): Promise<BsddSearchPage>
Parameters
- query: BsddSearchQuery
Returns Promise<BsddSearchPage>