Function relationship

  • relationship(get, post, __): {
        block: ((id: string) => Promise<true>);
        dms: ((id: string) => Promise<DM[]>);
        friend: ((id: string) => Promise<true>);
        unblock: ((id: string) => Promise<boolean>);
        unfriend: ((id: string) => Promise<boolean>);
    }

  • Parameters

    • get: (<T>(__namedParameters: {
          headers?: Record<string, string>;
          json?: boolean;
          token?: null | string;
          uri: string;
      }) => Promise<Res<T>>)
        • <T>(__namedParameters): Promise<Res<T>>

        • Type Parameters

          • T = any

          Parameters

          • __namedParameters: {
                headers?: Record<string, string>;
                json?: boolean;
                token?: null | string;
                uri: string;
            }
            • Optionalheaders?: Record<string, string>
            • Optionaljson?: boolean
            • Optionaltoken?: null | string
            • uri: string

          Returns Promise<Res<T>>

    • post: (<T>(__namedParameters: {
          body: Record<string, any>;
          headers?: Record<string, string>;
          json?: boolean;
          token?: string;
          uri: string;
      }) => Promise<Res<T>>)
        • <T>(__namedParameters): Promise<Res<T>>

        • Type Parameters

          • T = any

          Parameters

          • __namedParameters: {
                body: Record<string, any>;
                headers?: Record<string, string>;
                json?: boolean;
                token?: string;
                uri: string;
            }
            • body: Record<string, any>
            • Optionalheaders?: Record<string, string>
            • Optionaljson?: boolean
            • Optionaltoken?: string
            • uri: string

          Returns Promise<Res<T>>

    • __: APIDefaults

    Returns {
        block: ((id: string) => Promise<true>);
        dms: ((id: string) => Promise<DM[]>);
        friend: ((id: string) => Promise<true>);
        unblock: ((id: string) => Promise<boolean>);
        unfriend: ((id: string) => Promise<boolean>);
    }

    • block: ((id: string) => Promise<true>)

      Block a user

        • (id): Promise<true>

        • Parameters

          • id: string

          Returns Promise<true>

    • dms: ((id: string) => Promise<DM[]>)
        • (id): Promise<DM[]>

        • Parameters

          • id: string

          Returns Promise<DM[]>

    • friend: ((id: string) => Promise<true>)

      Friend a user

        • (id): Promise<true>

        • Parameters

          • id: string

          Returns Promise<true>

    • unblock: ((id: string) => Promise<boolean>)

      Unblock a user. Note: unblocking a user will unfriend them if they are friended.

        • (id): Promise<boolean>

        • Parameters

          • id: string

          Returns Promise<boolean>

    • unfriend: ((id: string) => Promise<boolean>)

      Unfriend a user. Note: unfriending a user will unblock them if they are blocked.

        • (id): Promise<boolean>

        • Parameters

          • id: string

          Returns Promise<boolean>

Settings

Member Visibility