Options
All
  • Public
  • Public/Protected
  • All
Menu

Module backend-federation-client

@unifed/backend-federation-client

This package contains a HTTP client for interacting with federation servers. Servers must confirm to the protocol specified here.

Underlying details are abstracted away into an easy-to-use programmatic interface.

Index

Classes

Type aliases

Functions

Type aliases

CreatePostProps

CreatePostProps: Pick<Post, "community" | "body" | "parentPost" | "title">

Type containing properties needed to create a post.

internal

Endpoints

Endpoints: string | string[]

Type representing a REST endpoint.

internal

UpdatePostProps

UpdatePostProps: Omit<CreatePostProps, "parentPost" | "community"> & Pick<Post, "id">

Type containing properties needed to update a post.

internal

Functions

isStringArray

  • isStringArray(values: unknown): values is string[]

  • Predicate to check if a given value is an array of strings.

    internal

    Parameters

    • values: unknown

      Values to check.

    Returns values is string[]

    A predicate indicating if the given values are an array of strings.

Generated using TypeDoc