Class NodeInfoHttp

Hierarchy

LemmyController
- NodeInfoHttp

Index

Constructors

constructor

Methods

getHeader getHeaders getStatus nodeinfo setHeader setHeaders setStatus upload uploadWithQuery wrapper

Constructors

constructor

new NodeInfoHttp(
    baseUrl: string,
    options?: {
        fetchFunction?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        headers?: { [key: string]: string };
    },
): NodeInfoHttp
Generates a new instance of LemmyHttp.
Parameters
- baseUrl: string
  the base url, without the vX version: https://lemmy.ml -> goes to https://lemmy.ml/api/vX
- Optionaloptions: {
      fetchFunction?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      headers?: { [key: string]: string };
  }
  - OptionalfetchFunction?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalheaders?: { [key: string]: string }
Returns NodeInfoHttp
Inherited from LemmyController.constructor
- Defined in src/http.ts:252

Methods

getHeader

getHeader(name: string): string | string[] | undefined
Parameters
- name: string
Returns string | string[] | undefined
Inherited from LemmyController.getHeader
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:11

getHeaders

getHeaders(): { [name: string]: string | string[] | undefined }
Returns { [name: string]: string | string[] | undefined }
Inherited from LemmyController.getHeaders
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:12

getStatus

getStatus(): number | undefined
Returns number | undefined
Inherited from LemmyController.getStatus
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:8

nodeinfo

nodeinfo(options?: RequestOptions): Promise<NodeInfo>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<NodeInfo>
- Defined in src/http.ts:2997

setHeader

setHeader<H extends keyof OutgoingHttpHeaders>(
name: H,
value?: HeaderValue<H>,
): void
Type Parameters
- H extends keyof OutgoingHttpHeaders
Parameters
- name: H
- Optionalvalue: HeaderValue<H>
Returns void
Inherited from LemmyController.setHeader
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:9
setHeader(name: string, value?: string | string[]): void
Parameters
- name: string
- Optionalvalue: string | string[]
Returns void
Inherited from LemmyController.setHeader
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:10

setHeaders

setHeaders(headers: { [key: string]: string }): void
Set the headers (can be used to set the auth header)
Parameters
- headers: { [key: string]: string }
Returns void
Inherited from LemmyController.setHeaders
- Defined in src/http.ts:358

setStatus

setStatus(statusCode: number): void
Parameters
- statusCode: number
Returns void
Inherited from LemmyController.setStatus
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:7

upload

upload<ResponseType>(
    path: string,
    __namedParameters: UploadImage,
    options?: RequestOptions,
): Promise<ResponseType>
Type Parameters
- ResponseType
Parameters
- path: string
- __namedParameters: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<ResponseType>
Inherited from LemmyController.upload
- Defined in src/http.ts:274

uploadWithQuery

uploadWithQuery<QueryType extends object, ResponseType>(
    path: string,
    query: QueryType,
    __namedParameters: UploadImage,
    options?: RequestOptions,
): Promise<ResponseType>
Type Parameters
- QueryType extends object
- ResponseType
Parameters
- path: string
- query: QueryType
- __namedParameters: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<ResponseType>
Inherited from LemmyController.uploadWithQuery
- Defined in src/http.ts:290

wrapper

wrapper<BodyType extends object, ResponseType>(
    type_: HttpType,
    endpoint: string,
    form: BodyType,
    options: RequestOptions | undefined,
    no_prefix?: boolean,
): Promise<ResponseType>
Type Parameters
- BodyType extends object
- ResponseType
Parameters
- type_: HttpType
- endpoint: string
- form: BodyType
- options: RequestOptions | undefined
- no_prefix: boolean = false
Returns Promise<ResponseType>
Inherited from LemmyController.wrapper
- Defined in src/http.ts:303

Class NodeInfoHttp

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

OptionalfetchFunction?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>;}

Optionalheaders?: { [key: string]: string }

Returns NodeInfoHttp

Methods

getHeader

Parameters

Returns string | string[] | undefined

getHeaders

Returns { [name: string]: string | string[] | undefined }

getStatus

Returns number | undefined

nodeinfo

Parameters

Returns Promise<NodeInfo>

setHeader

Type Parameters

Parameters

Returns void

Parameters

Returns void

setHeaders

Parameters

Returns void

setStatus

Parameters

Returns void

upload

Type Parameters

Parameters

Returns Promise<ResponseType>

uploadWithQuery

Type Parameters

Parameters

Returns Promise<ResponseType>

wrapper

Type Parameters

Parameters

Returns Promise<ResponseType>

Settings

On This Page

`Optional`fetchFunction?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`headers?: { [key: string]: string }