Class RequestFilterBuilder

Builder class for a single request filter

Index

Constructors

constructor

new RequestFilterBuilder(f?): RequestFilterBuilder
Parameters
- Optional f: ReqFilter
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:179

Properties

`Private` #filter

#filter: ReqFilter

`Private` #relays

#relays: Set<string> = ...

Accessors

filter

get filter(): {
    #a?: string[];
    #d?: string[];
    #e?: string[];
    #g?: string[];
    #p?: string[];
    #r?: string[];
    #t?: string[];
    authors?: string[];
    ids?: string[];
    kinds?: number[];
    limit?: number;
    not?: ReqFilter;
    search?: string;
    since?: number;
    until?: number;
}
Returns {
    #a?: string[];
    #d?: string[];
    #e?: string[];
    #g?: string[];
    #p?: string[];
    #r?: string[];
    #t?: string[];
    authors?: string[];
    ids?: string[];
    kinds?: number[];
    limit?: number;
    not?: ReqFilter;
    search?: string;
    since?: number;
    until?: number;
}
- Optional #a?: string[]
- Optional #d?: string[]
- Optional #e?: string[]
- Optional #g?: string[]
- Optional #p?: string[]
- Optional #r?: string[]
- Optional #t?: string[]
- Optional authors?: string[]
- Optional ids?: string[]
- Optional kinds?: number[]
- Optional limit?: number
- Optional not?: ReqFilter
- Optional search?: string
- Optional since?: number
- Optional until?: number
- Defined in packages/system/src/request-builder.ts:183

Methods

authors

authors(authors?): RequestFilterBuilder
Parameters
- Optional authors: string[]
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:206

build

build(relays, options?): BuiltRawReqFilter[]
Build/expand this filter into a set of relay specific queries
Parameters
- relays: RelayCache
- Optional options: RequestBuilderOptions
Returns BuiltRawReqFilter[]
- Defined in packages/system/src/request-builder.ts:281

ids

ids(ids): RequestFilterBuilder
Parameters
- ids: string[]
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:201

kinds

kinds(kinds?): RequestFilterBuilder
Parameters
- Optional kinds: EventKind[]
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:212

limit

limit(limit?): RequestFilterBuilder
Parameters
- Optional limit: number
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:230

link

link(link): RequestFilterBuilder
Get event from link
Parameters
- link: NostrLink
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:251

relay

relay(u): RequestFilterBuilder
Use a specific relay for this request filter
Parameters
- u: string | string[]
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:190

replyToLink

replyToLink(links): RequestFilterBuilder
Get replies to link with e/a tags
Parameters
- links: NostrLink[]
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:266

search

search(keyword?): RequestFilterBuilder
Parameters
- Optional keyword: string
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:242

since

since(since?): RequestFilterBuilder
Parameters
- Optional since: number
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:218

until

until(until?): RequestFilterBuilder
Parameters
- Optional until: number
Returns RequestFilterBuilder
- Defined in packages/system/src/request-builder.ts:224

Class RequestFilterBuilder

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional f: ReqFilter

Returns RequestFilterBuilder

Properties

Private #filter

Private #relays

Accessors

filter

Returns { #a?: string[]; #d?: string[]; #e?: string[]; #g?: string[]; #p?: string[]; #r?: string[]; #t?: string[]; authors?: string[]; ids?: string[]; kinds?: number[]; limit?: number; not?: ReqFilter; search?: string; since?: number; until?: number; }

Optional #a?: string[]

Optional #d?: string[]

Optional #e?: string[]

Optional #g?: string[]

Optional #p?: string[]

Optional #r?: string[]

Optional #t?: string[]

Optional authors?: string[]

Optional ids?: string[]

Optional kinds?: number[]

Optional limit?: number

Optional not?: ReqFilter

Optional search?: string

Optional since?: number

Optional until?: number

Methods

authors

Parameters

Optional authors: string[]

Returns RequestFilterBuilder

build

Parameters

relays: RelayCache

Optional options: RequestBuilderOptions

Returns BuiltRawReqFilter[]

ids

Parameters

ids: string[]

Returns RequestFilterBuilder

kinds

Parameters

Optional kinds: EventKind[]

Returns RequestFilterBuilder

limit

Parameters

Optional limit: number

Returns RequestFilterBuilder

link

Parameters

link: NostrLink

Returns RequestFilterBuilder

relay

Parameters

u: string | string[]

Returns RequestFilterBuilder

replyToLink

Parameters

links: NostrLink[]

Returns RequestFilterBuilder

search

Parameters

Optional keyword: string

Returns RequestFilterBuilder

since

Parameters

Optional since: number

Returns RequestFilterBuilder

tag

Parameters

key: string

Optional value: string[]

Returns RequestFilterBuilder

until

`Optional` f: ReqFilter

`Private` #filter

`Private` #relays

Returns {
#a?: string[];
#d?: string[];
#e?: string[];
#g?: string[];
#p?: string[];
#r?: string[];
#t?: string[];
authors?: string[];
ids?: string[];
kinds?: number[];
limit?: number;
not?: ReqFilter;
search?: string;
since?: number;
until?: number;
}

`Optional` #a?: string[]

`Optional` #d?: string[]

`Optional` #e?: string[]

`Optional` #g?: string[]

`Optional` #p?: string[]

`Optional` #r?: string[]

`Optional` #t?: string[]

`Optional` authors?: string[]

`Optional` ids?: string[]

`Optional` kinds?: number[]

`Optional` limit?: number

`Optional` not?: ReqFilter

`Optional` search?: string

`Optional` since?: number

`Optional` until?: number

`Optional` authors: string[]

`Optional` options: RequestBuilderOptions

`Optional` kinds: EventKind[]

`Optional` limit: number

`Optional` keyword: string

`Optional` since: number

`Optional` value: string[]

`Optional` until: number