Skip to main content
Home
Browse packagesDocsSign in
This release is 9 versions behind 1.3.0 — the latest version of @fedify/fedify. Jump to latest

@fedify/fedify@1.2.0
Built and signed on GitHub Actions

dahlia/fedify

An ActivityPub/fediverse server framework

This package works with Node.js, Deno, Bun
This package works with Node.js
This package works with Deno
This package works with Bun
JSR Score
100%
Published
a month ago (1.2.0)
class Collection
extends Object

A Collection is a subtype of Object that represents ordered or unordered sets of Object or Link instances.

Refer to the Activity Streams 2.0 Core specification for a complete description of the Collection type.

Constructors

new
Collection(
values: { id?: URL | null; attachments?: (
Object
| Link
| PropertyValue
| URL
)[]; attribution?:
Application
| Group
| Organization
| Person
| Service
| URL
| null
; attributions?: (
Application
| Group
| Organization
| Person
| Service
| URL
)[]; audience?:
Object
| URL
| null
; audiences?: (Object | URL)[]; content?:
string
| LanguageString
| null
; contents?: ((string | LanguageString))[]; contexts?: (
Object
| Link
| URL
)[]; name?:
string
| LanguageString
| null
; names?: ((string | LanguageString))[]; endTime?: Temporal.Instant | null; generators?: (
Object
| Link
| URL
)[]; icon?:
Image
| URL
| null
; icons?: (Image | URL)[]; image?:
Image
| URL
| null
; images?: (Image | URL)[]; replyTarget?:
Object
| Link
| URL
| null
; replyTargets?: (
Object
| Link
| URL
)[]; location?:
Object
| Link
| URL
| null
; locations?: (
Object
| Link
| URL
)[]; preview?:
Link
| Object
| URL
| null
; previews?: (
Link
| Object
| URL
)[]; published?: Temporal.Instant | null; replies?:
Collection
| URL
| null
; startTime?: Temporal.Instant | null; summary?:
string
| LanguageString
| null
; summaries?: ((string | LanguageString))[]; tags?: (
Object
| Link
| URL
)[]; updated?: Temporal.Instant | null; url?:
URL
| Link
| null
; urls?: ((URL | Link))[]; to?:
Object
| URL
| null
; tos?: (Object | URL)[]; bto?:
Object
| URL
| null
; btos?: (Object | URL)[]; cc?:
Object
| URL
| null
; ccs?: (Object | URL)[]; bcc?:
Object
| URL
| null
; bccs?: (Object | URL)[]; mediaType?: string | null; duration?: Temporal.Duration | null; sensitive?: boolean | null; source?: Source | null; proof?:
DataIntegrityProof
| URL
| null
; proofs?: (DataIntegrityProof | URL)[]; totalItems?: number | null; current?:
CollectionPage
| URL
| null
; first?:
CollectionPage
| URL
| null
; last?:
CollectionPage
| URL
| null
; items?: (
Object
| Link
| URL
)[]; },
unnamed 1?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; },
)

Constructs a new instance of Collection with the given values.

Properties

readonly
currentId: URL | null

Similar to Collection.getCurrent, but returns its @id URL instead of the object itself.

readonly
firstId: URL | null

Similar to Collection.getFirst, but returns its @id URL instead of the object itself.

readonly
itemIds: URL[]

Similar to Collection.getItems, but returns their @ids instead of the objects themselves.

readonly
lastId: URL | null

Similar to Collection.getLast, but returns its @id URL instead of the object itself.

readonly
totalItems: number | null

A non-negative integer specifying the total number of objects contained by the logical view of the collection. This number might not reflect the actual number of items serialized within the Collection object instance.

Methods

[Symbol.for("nodejs.util.inspect.custom")](
_depth: number,
options: unknown,
inspect: (
value: unknown,
options: unknown,
) => string,
): string
protected
_getCustomInspectProxy(): Record<string, unknown>
clone(
values?: { id?: URL | null; attachments?: (
Object
| Link
| PropertyValue
| URL
)[]; attribution?:
Application
| Group
| Organization
| Person
| Service
| URL
| null
; attributions?: (
Application
| Group
| Organization
| Person
| Service
| URL
)[]; audience?:
Object
| URL
| null
; audiences?: (Object | URL)[]; content?:
string
| LanguageString
| null
; contents?: ((string | LanguageString))[]; contexts?: (
Object
| Link
| URL
)[]; name?:
string
| LanguageString
| null
; names?: ((string | LanguageString))[]; endTime?: Temporal.Instant | null; generators?: (
Object
| Link
| URL
)[]; icon?:
Image
| URL
| null
; icons?: (Image | URL)[]; image?:
Image
| URL
| null
; images?: (Image | URL)[]; replyTarget?:
Object
| Link
| URL
| null
; replyTargets?: (
Object
| Link
| URL
)[]; location?:
Object
| Link
| URL
| null
; locations?: (
Object
| Link
| URL
)[]; preview?:
Link
| Object
| URL
| null
; previews?: (
Link
| Object
| URL
)[]; published?: Temporal.Instant | null; replies?:
Collection
| URL
| null
; startTime?: Temporal.Instant | null; summary?:
string
| LanguageString
| null
; summaries?: ((string | LanguageString))[]; tags?: (
Object
| Link
| URL
)[]; updated?: Temporal.Instant | null; url?:
URL
| Link
| null
; urls?: ((URL | Link))[]; to?:
Object
| URL
| null
; tos?: (Object | URL)[]; bto?:
Object
| URL
| null
; btos?: (Object | URL)[]; cc?:
Object
| URL
| null
; ccs?: (Object | URL)[]; bcc?:
Object
| URL
| null
; bccs?: (Object | URL)[]; mediaType?: string | null; duration?: Temporal.Duration | null; sensitive?: boolean | null; source?: Source | null; proof?:
DataIntegrityProof
| URL
| null
; proofs?: (DataIntegrityProof | URL)[]; totalItems?: number | null; current?:
CollectionPage
| URL
| null
; first?:
CollectionPage
| URL
| null
; last?:
CollectionPage
| URL
| null
; items?: (
Object
| Link
| URL
)[]; },
options?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; },
): Collection

Clones this instance, optionally updating it with the given values.

getCurrent(options?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; suppressError?: boolean; }): Promise<CollectionPage | null>

In a paged Collection, indicates the page that contains the most recently updated member items.

getFirst(options?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; suppressError?: boolean; }): Promise<CollectionPage | null>

In a paged Collection, indicates the furthest preceding page of items in the collection.

getItems(options?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; suppressError?: boolean; }): AsyncIterable<Object | Link>

Identifies the items contained in a collection. The items might be ordered or unordered.

getLast(options?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; suppressError?: boolean; }): Promise<CollectionPage | null>

In a paged Collection, indicates the furthest proceeding page of the collection.

toJsonLd(options?: { format?: "compact" | "expand"; contextLoader?: DocumentLoader; context?:
string
| Record<string, string>
| (string | Record<string, string>)[]
; }): Promise<unknown>

Converts this object to a JSON-LD structure.

Static Properties

readonly
typeId: URL

The type URI of Collection: https://www.w3.org/ns/activitystreams#Collection.

Static Methods

fromJsonLd(
json: unknown,
options?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; },
): Promise<Collection>

Converts a JSON-LD structure to an object of this type.

Add Package

deno add jsr:@fedify/fedify

Import symbol

import { Collection } from "@fedify/fedify";

---- OR ----

Import directly with a jsr specifier

import { Collection } from "jsr:@fedify/fedify";

Add Package

npx jsr add @fedify/fedify

Import symbol

import { Collection } from "@fedify/fedify";

Add Package

yarn dlx jsr add @fedify/fedify

Import symbol

import { Collection } from "@fedify/fedify";

Add Package

pnpm dlx jsr add @fedify/fedify

Import symbol

import { Collection } from "@fedify/fedify";

Add Package

bunx jsr add @fedify/fedify

Import symbol

import { Collection } from "@fedify/fedify";