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

@fedify/fedify@1.2.1
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
3 months ago (1.2.1)
class Relationship
extends Object

Describes a relationship between two individuals. The Relationship.subject and Relationship.object properties are used to identify the connected individuals.

See 5.2 Representing Relationships Between Entities for additional information.

Constructors

new
Relationship(
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)[]; subject?:
Object
| URL
| null
; object?:
Object
| URL
| null
; objects?: (Object | URL)[]; relationship?:
Object
| URL
| null
; relationships?: (Object | URL)[]; },
unnamed 1?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; },
)

Constructs a new instance of Relationship with the given values.

Properties

readonly
objectId: URL | null

Similar to Relationship.getObject, but returns its @id URL instead of the object itself.

readonly
objectIds: URL[]

Similar to Relationship.getObjects, but returns their @ids instead of the objects themselves.

readonly
relationshipId: URL | null

Similar to Relationship.getRelationship, but returns its @id URL instead of the object itself.

readonly
relationshipIds: URL[]

Similar to Relationship.getRelationships, but returns their @ids instead of the objects themselves.

readonly
subjectId: URL | null

Similar to Relationship.getSubject, but returns its @id URL instead of the object itself.

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)[]; subject?:
Object
| URL
| null
; object?:
Object
| URL
| null
; objects?: (Object | URL)[]; relationship?:
Object
| URL
| null
; relationships?: (Object | URL)[]; },
options?: { documentLoader?: DocumentLoader; contextLoader?: DocumentLoader; },
): Relationship

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

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

Describes the entity to which the Relationship.subject is related.

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

Describes the entity to which the Relationship.subject is related.

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

On a Relationship object, the Relationship.relationship property identifies the kind of relationship that exists between Relationship.subject and Relationship.object.

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

On a Relationship object, the Relationship.relationship property identifies the kind of relationship that exists between Relationship.subject and Relationship.object.

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

On a Relationship object, the Relationship.subject property identifies one of the connected individuals. For instance, for a Relationship object describing "John is related to Sally", the Relationship.subject property would refer to John.

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 Relationship: https://www.w3.org/ns/activitystreams#Relationship.

Static Methods

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

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

Add Package

deno add jsr:@fedify/fedify

Import symbol

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

---- OR ----

Import directly with a jsr specifier

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

Add Package

npx jsr add @fedify/fedify

Import symbol

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

Add Package

yarn dlx jsr add @fedify/fedify

Import symbol

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

Add Package

pnpm dlx jsr add @fedify/fedify

Import symbol

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

Add Package

bunx jsr add @fedify/fedify

Import symbol

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