Class Profile

Cast a kind 0 event to a Profile

Hierarchy (View Summary)

EventCast<ProfileEvent>
- Profile

Index

Constructors

Properties

Accessors

about author banner birthday bot createdAt displayName dnsIdentity id languages lightningAddress lud06 lud16 metadata name picture seen uid website

Methods

Constructors

constructor

new Profile(event: NostrEvent, store: CastRefEventStore): Profile
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns Profile
Overrides EventCast.constructor
- Defined in common/src/casts/profile.ts:7

Properties

`Readonly`event

event: ProfileEvent

`Readonly`store

store: CastRefEventStore

Accessors

about

get about(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:20

author

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

Returns User
Inherited from EventCast.author
- Defined in common/src/casts/cast.ts:59

get banner(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:26

birthday

get birthday(): { day?: number; month?: number; year?: number } | undefined
Returns { day?: number; month?: number; year?: number } | undefined
- { day?: number; month?: number; year?: number }
  - Optionalday?: number
    Birth day (1-31)
  - Optionalmonth?: number
    Birth month (1-12)
  - Optionalyear?: number
    Birth year
- undefined
- Defined in common/src/casts/profile.ts:48

bot

get bot(): boolean | undefined
Returns boolean | undefined
- Defined in common/src/casts/profile.ts:45

createdAt

get createdAt(): Date
Returns Date
Inherited from EventCast.createdAt
- Defined in common/src/casts/cast.ts:54

displayName

get displayName(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:17

dnsIdentity

get dnsIdentity(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:29

id

get id(): string
Returns string
Inherited from EventCast.id
- Defined in common/src/casts/cast.ts:47

languages

get languages(): string[] | undefined
Returns string[] | undefined
- Defined in common/src/casts/profile.ts:51

lightningAddress

get lightningAddress(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:42

lud06

get lud06(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:38

lud16

get lud16(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:35

metadata

get metadata(): ProfileContent
Returns ProfileContent
- Defined in common/src/casts/profile.ts:11

name

get name(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:14

picture

get picture(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:23

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 common/src/casts/cast.ts:64

uid

get uid(): string
Returns string
Inherited from EventCast.uid
- Defined in common/src/casts/cast.ts:50

website

get website(): string | undefined
Returns string | undefined
- Defined in common/src/casts/profile.ts:32

Methods

`Protected`$$ref

$$ref<Return extends unknown>(
key: string,
builder: (store: CastRefEventStore) => Observable<Return>,
): ChainableObservable<Return>
Internal method for creating a reference
Type Parameters
- Return extends unknown
Parameters
- key: string
- builder: (store: CastRefEventStore) => Observable<Return>
Returns ChainableObservable<Return>
Inherited from EventCast.$$ref
- Defined in common/src/casts/cast.ts:78