Class Report

A NIP-56 report with typed targets and related users and events

Hierarchy (View Summary)

Casts.EventCast<KnownEvent<typeof REPORT_KIND>>
- Report

Index

Constructors

Properties

Methods

Constructors

constructor

new Report(event: NostrEvent, store: Casts.CastRefEventStore): Casts.Report
Creates a report cast
Parameters
- event: NostrEvent
- store: Casts.CastRefEventStore
Returns Casts.Report

Throws
if the event lacks valid report targets or context
Overrides EventCast.constructor
- Defined in packages/common/src/casts/report.ts:24

Properties

`Readonly`event

event: KnownEvent

`Readonly`store

store: Casts.CastRefEventStore

Accessors

author

get author(): Casts.User
Get the User that authored this event

Returns Casts.User
Inherited from EventCast.author
- Defined in packages/core/dist/casts/event.d.ts:32

blobs

get blobs(): string[] | undefined
Gets the blob hashes being reported (for event reports with x tags)

Returns string[] | undefined
- Defined in packages/common/src/casts/report.ts:117

comment

get comment(): string | undefined
Gets the comment/content of the report

Returns string | undefined
- Defined in packages/common/src/casts/report.ts:80

coordinate

get coordinate(): string | null
Returns the NIP-01 address string for this event if its replaceable or addressable, otherwise returns null

Returns string | null
Inherited from EventCast.coordinate
- Defined in packages/core/dist/casts/event.d.ts:36

createdAt

get createdAt(): Date
Returns the created_at timestamp as a Date object

Returns Date
Inherited from EventCast.createdAt
- Defined in packages/core/dist/casts/event.d.ts:30

id

get id(): string
Alias for event.id

Returns string
Inherited from EventCast.id
- Defined in packages/core/dist/casts/event.d.ts:24

isBlobReport

get isBlobReport(): boolean
Checks whether this report explicitly targets media

Returns boolean
- Defined in packages/common/src/casts/report.ts:40

isEventReport

get isEventReport(): boolean
Checks if this is an event report

Returns boolean
- Defined in packages/common/src/casts/report.ts:70

isUserReport

get isUserReport(): boolean
Checks if this is a user report

Returns boolean
- Defined in packages/common/src/casts/report.ts:65

kind

get kind(): number
Alias for event.kind

Returns number
Inherited from EventCast.kind
- Defined in packages/core/dist/casts/event.d.ts:26

pointer

get pointer(): AddressPointer | EventPointer
Returns a single EventPointer or AddressPointer for this event

Returns AddressPointer | EventPointer
Inherited from EventCast.pointer
- Defined in packages/core/dist/casts/event.d.ts:40

reason

get reason(): ReportReason | undefined
Gets the reason for the report

Returns ReportReason | undefined
- Defined in packages/common/src/casts/report.ts:75

replaceableAddress

get replaceableAddress(): string | null
Alias for coordinate

Returns string | null
Inherited from EventCast.replaceableAddress
- Defined in packages/core/dist/casts/event.d.ts:38

reported

get reported(): ReportedUser | ReportedEvent | null
Gets the parsed report data (either a user or event report)

Returns ReportedUser | ReportedEvent | null
- Defined in packages/common/src/casts/report.ts:60

reportedEvent$

get reportedEvent$(): Observable.ChainableObservable<NostrEvent | undefined>
Gets the event being reported (for event reports)

Returns Observable.ChainableObservable<NostrEvent | undefined>
- Defined in packages/common/src/casts/report.ts:103

reportedEventId

get reportedEventId(): string | undefined
Gets the event ID being reported (for event reports)

Returns string | undefined
- Defined in packages/common/src/casts/report.ts:98

reportedEventPointers

get reportedEventPointers(): EventPointer[]
Returns pointers to all reported events and blob context events

Returns EventPointer[]
- Defined in packages/common/src/casts/report.ts:45

reportedEvents$

get reportedEvents$(): Observable.ChainableObservable<
(NostrEvent | undefined)[],
>
Subscribes to all reported events and blob context events

Returns Observable.ChainableObservable<(NostrEvent | undefined)[]>
- Defined in packages/common/src/casts/report.ts:52

reportedPubkey

get reportedPubkey(): string | undefined
Gets the pubkey of the user being reported

Returns string | undefined
- Defined in packages/common/src/casts/report.ts:86

reportedUser

get reportedUser(): Casts.User | undefined
Gets the User being reported

Returns Casts.User | undefined
- Defined in packages/common/src/casts/report.ts:91

reportedUsers

get reportedUsers(): Casts.User[]
Returns all explicitly reported users

Returns Casts.User[]
- Defined in packages/common/src/casts/report.ts:35

seen

get seen(): Set<string> | undefined
Return the set of relays this event was seen on

Returns Set<string> | undefined
Inherited from EventCast.seen
- Defined in packages/core/dist/casts/event.d.ts:34

servers

get servers(): string[]
Gets the server URLs for blob reports

Returns string[]
- Defined in packages/common/src/casts/report.ts:122

targets

get targets(): ReportTarget[]
Returns every explicitly reported target with its reason

Returns ReportTarget[]
- Defined in packages/common/src/casts/report.ts:30

uid

get uid(): string
Returns the unique identifier for this event

Returns string
Inherited from EventCast.uid
- Defined in packages/core/dist/casts/event.d.ts:28

Methods

`Protected`$$ref

$$ref<Return extends unknown>(
key: string,
builder: (store: Casts.CastRefEventStore) => Observable<Return>,
): Observable.ChainableObservable<Return>
Internal method for creating a reference
Type Parameters
- Return extends unknown
Parameters
- key: string
- builder: (store: Casts.CastRefEventStore) => Observable<Return>
Returns Observable.ChainableObservable<Return>
Inherited from EventCast.$$ref
- Defined in packages/core/dist/casts/event.d.ts:43