Class HDKXSingleton

For sharing access to a single event.

USE CASE: sharing a single note, or a pointer to another index

Hierarchy

HDKTimeBased
- HDKXSingleton

Index

Constructors

Properties

documents encryptParent eventTag parentDocument? signingParent type

Methods

createDeleteEvent createEvent createNostrEvent getDocumentFromJson getDocumentKeyset getFilters listen query readEvent readNostrEvent toJSON verifyEvent

Constructors

constructor

new HDKXSingleton(signingParent, encryptParent): HDKXSingleton
Parameters
- signingParent: HDKey
- encryptParent: HDKey
Returns HDKXSingleton
Overrides HDKTimeBased.constructor
- Defined in hdkx/HDKXSingleton.ts:19

Properties

documents

documents: ContentDocument[] = []

encryptParent

encryptParent: HDKey

eventTag

eventTag: string

`Optional` parentDocument

parentDocument?: ContentDocument

signingParent

signingParent: HDKey

type

type: HDKIndexType

Methods

createDeleteEvent

createDeleteEvent(doc): Promise<Event<number>>
Parameters
- doc: ContentDocument
Returns Promise<Event<number>>
Inherited from HDKTimeBased.createDeleteEvent
- Defined in hdkx/HDKIndex.ts:147

createEvent

createEvent(doc, __namedParameters?): Promise<Event<number>>
Parameters
- doc: ContentDocument
- __namedParameters: ContentPublishOptions = {}
Returns Promise<Event<number>>
Inherited from HDKTimeBased.createEvent
- Defined in hdkx/HDKTimeBased.ts:14

`Protected` createNostrEvent

createNostrEvent(doc, keyset, created_at, eventTag?): Event<number>
Parameters
- doc: ContentDocument
- keyset: DocumentKeyset
- created_at: number
- eventTag: string = ...
Returns Event<number>
Inherited from HDKTimeBased.createNostrEvent
- Defined in hdkx/HDKIndex.ts:133

`Protected` getDocumentFromJson

getDocumentFromJson(json, event, keyset, docIndex, version): ContentDocument
Parameters
- json: string
- event: Event<number>
- keyset: DocumentKeyset
- docIndex: number
- version: number
Returns ContentDocument
Inherited from HDKTimeBased.getDocumentFromJson
- Defined in hdkx/HDKIndex.ts:183

getDocumentKeyset

getDocumentKeyset(docIndex, event?): DocumentKeyset
Parameters
- docIndex: number
- Optional event: Event<number>
Returns DocumentKeyset
Overrides HDKTimeBased.getDocumentKeyset
- Defined in hdkx/HDKXSingleton.ts:30

getFilters

getFilters(__namedParameters?): Filter[]
Parameters
- __namedParameters: HDKIndexQueryArgs = {}
Returns Filter[]
Overrides HDKTimeBased.getFilters
- Defined in hdkx/HDKXSingleton.ts:26

listen

listen<TDocType>(queryArgs?): [Observable<TDocType>, (() => void)]
Type Parameters
- TDocType extends ContentDocument
Parameters
- queryArgs: HDKIndexQueryArgs = ...
Returns [Observable<TDocType>, (() => void)]
Inherited from HDKTimeBased.listen
- Defined in hdkx/HDKTimeBased.ts:52

query

query<TDocType>(queryArgs): [Observable<TDocType>, (() => void)]
Type Parameters
- TDocType extends ContentDocument
Parameters
- queryArgs: HDKIndexQueryArgs
Returns [Observable<TDocType>, (() => void)]
Inherited from HDKTimeBased.query
- Defined in hdkx/HDKTimeBased.ts:56

readEvent

readEvent(event): Promise<undefined | ContentDocument>
Parameters
- event: Event<number>
Returns Promise<undefined | ContentDocument>
Inherited from HDKTimeBased.readEvent
- Defined in hdkx/HDKTimeBased.ts:21

`Protected` readNostrEvent

readNostrEvent(event, keyset, docIndex): Promise<ContentDocument>
Parameters
- event: Event<number>
- keyset: DocumentKeyset
- docIndex: number
Returns Promise<ContentDocument>
Inherited from HDKTimeBased.readNostrEvent
- Defined in hdkx/HDKIndex.ts:163

toJSON

toJSON(): HDKIndexDTO
Returns HDKIndexDTO
Inherited from HDKTimeBased.toJSON
- Defined in hdkx/HDKIndex.ts:203

verifyEvent

verifyEvent(doc): boolean
Parameters
- doc: ContentDocument
Returns boolean
Overrides HDKTimeBased.verifyEvent
- Defined in hdkx/HDKXSingleton.ts:39