Class Client

constructor

• new Client(options?: Options): Client

  Creates a Tumblr API client using the given options

  Parameters

  • Optionaloptions: Options

    client options

  Returns Client

ReadonlybaseUrl

blogPosts

Readonlyversion

Static Readonlyversion

blogAvatar

• blogAvatar(
      blogIdentifier: string,
      sizeOrCallback?:
          | TumblrClientCallback
          | 16
          | 24
          | 30
          | 40
          | 48
          | 64
          | 96
          | 128
          | 512,
      maybeCallback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the avatar URL for a blog

  Parameters

  • blogIdentifier: string

    blog name or URL

  • OptionalsizeOrCallback: TumblrClientCallback | 16 | 24 | 30 | 40 | 48 | 64 | 96 | 128 | 512

    optional data sent with the request

  • OptionalmaybeCallback: TumblrClientCallback

    invoked when the request completes

  Returns undefined | Promise<any>

  Promise if no callback is provided

blogDrafts

• blogDrafts(
      blogIdentifier: string,
      paramsOrCallback?:
          | TumblrClientCallback
          | { before_id?: number; filter?: PostFormatFilter },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the drafts for a blog

  Parameters

  • blogIdentifier: string

    blog name or URL

  • OptionalparamsOrCallback: TumblrClientCallback | { before_id?: number; filter?: PostFormatFilter }

    optional data sent with the request

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

blogFollowers

• blogFollowers(
      blogIdentifier: string,
      paramsOrCallback?:
          | TumblrClientCallback
          | { limit?: number; offset?: number },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the followers for a blog

  Parameters

  • blogIdentifier: string

    blog name or URL

  • OptionalparamsOrCallback: TumblrClientCallback | { limit?: number; offset?: number }

    optional data sent with the request

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

blogInfo

• blogInfo(
      blogIdentifier: string,
      paramsOrCallback?: TumblrClientCallback | { "fields[blogs]"?: string },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets information about a given blog

  Parameters

  • blogIdentifier: string

    blog name or URL

  • OptionalparamsOrCallback: TumblrClientCallback | { "fields[blogs]"?: string }

    query parameters

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

blogLikes

• blogLikes(
      blogIdentifier: string,
      paramsOrCallback?:
          | TumblrClientCallback
          | { after?: number; before?: number; limit?: number; offset?: number },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the likes for a blog

  Parameters

  • blogIdentifier: string

    blog name or URL

  • OptionalparamsOrCallback:
        | TumblrClientCallback
        | { after?: number; before?: number; limit?: number; offset?: number }

    optional data sent with the request

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

blogQueue

• blogQueue(
      blogIdentifier: string,
      paramsOrCallback?:
          | TumblrClientCallback
          | { filter?: "text"
          | "raw"; limit?: number; offset?: number },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the queue for a blog

  Parameters

  • blogIdentifier: string

    blog name or URL

  • OptionalparamsOrCallback:
        | TumblrClientCallback
        | { filter?: "text"
        | "raw"; limit?: number; offset?: number }

    optional data sent with the request

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

blogSubmissions

• blogSubmissions(
      blogIdentifier: string,
      paramsOrCallback?:
          | TumblrClientCallback
          | { filter?: PostFormatFilter; offset?: number },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the submissions for a blog

  Parameters

  • blogIdentifier: string

    blog name or URL

  • OptionalparamsOrCallback: TumblrClientCallback | { filter?: PostFormatFilter; offset?: number }

    optional data sent with the request

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

createLegacyPost

• createLegacyPost(
      blogIdentifier: string,
      params: Record<string, any>,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Creates a post on the given blog.

  Parameters

  • blogIdentifier: string

    blog name or URL

  • params: Record<string, any>
  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

  Deprecated

  Legacy post creation methods are deprecated. Use NPF methods.

  See

  API Docs

createPost

• createPost(
      blogIdentifier: string,
      params: NpfPostParams | NpfReblogParams,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Create or reblog an NPF post

  Parameters

  • blogIdentifier: string

    blog name or URL

  • params: NpfPostParams | NpfReblogParams
  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

  See

  API Docs

  Example

  await client.createPost(blogName, {
    content: [
      {
        type: 'image',
        // Node's fs module, e.g. `import fs from 'node:fs';`
        media: fs.createReadStream(new URL('./image.jpg', import.meta.url)),
        alt_text: '…',
      },
    ],
  });
  Copy

deletePost

• deletePost(
      blogIdentifier: string,
      postId: string,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Deletes a given post

  Parameters

  • blogIdentifier: string

    blog name or URL

  • postId: string

    Post ID to delete

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

editLegacyPost

• editLegacyPost(
      blogIdentifier: string,
      params: Record<string, any>,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Edits a given post

  Parameters

  • blogIdentifier: string

    blog name or URL

  • params: Record<string, any>
  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

  Deprecated

  Legacy post creation methods are deprecated. Use NPF methods.

editPost

• editPost(
      blogIdentifier: string,
      postId: string,
      params: NpfPostParams | NpfReblogParams,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Edit an NPF post

  Parameters

  • blogIdentifier: string

    blog name or URL

  • postId: string

    Post ID

  • params: NpfPostParams | NpfReblogParams
  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

  See

  API Docs

followBlog

• followBlog(
      params: { url: string } | { email: string },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Follows a blog as the authenticating user

  Parameters

  • params: { url: string } | { email: string }

    parameters sent with the request

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

getRequest

• getRequest(
      apiPath: string,
      paramsOrCallback?: Record<string, any> | TumblrClientCallback,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Performs a GET request

  Parameters

  • apiPath: string

    URL path for the request

  • OptionalparamsOrCallback: Record<string, any> | TumblrClientCallback

    query parameters

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

likePost

• likePost(
      postId: string,
      reblogKey: string,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Likes a post as the authenticating user

  Parameters

  • postId: string

    ID of post to like

  • reblogKey: string

    Reblog key of post to like

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

postRequest

• postRequest(
      apiPath: string,
      paramsOrCallback?: Record<string, any> | TumblrClientCallback,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Performs a POST request

  Parameters

  • apiPath: string

    URL path for the request

  • OptionalparamsOrCallback: Record<string, any> | TumblrClientCallback
  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback was provided

putRequest

• putRequest(
      apiPath: string,
      paramsOrCallback?: Record<string, any> | TumblrClientCallback,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Performs a PUT request

  Parameters

  • apiPath: string

    URL path for the request

  • OptionalparamsOrCallback: Record<string, any> | TumblrClientCallback
  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback was provided

reblogPost

• reblogPost(
      blogIdentifier: string,
      params: Record<string, any>,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Reblogs a given post

  Parameters

  • blogIdentifier: string

    blog name or URL

  • params: Record<string, any>

    parameters sent with the request

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

  Deprecated

  Legacy post creation methods are deprecated. Use NPF methods.

returnPromises

• returnPromises(): void

  Returns void

  Deprecated

  Promises are returned if no callback is provided

taggedPosts

• taggedPosts(
      tag: string,
      paramsOrCallback?: Record<string, any> | TumblrClientCallback,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets posts tagged with the specified tag

  Parameters

  • tag: string

    The tag on the posts you'd like to retrieve

  • OptionalparamsOrCallback: Record<string, any> | TumblrClientCallback

    query parameters

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

unfollowBlog

• unfollowBlog(
      params: { url: string },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Unfollows a blog as the authenticating user

  Parameters

  • params: { url: string }

    parameters sent with the request

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

unlikePost

• unlikePost(
      postId: string,
      reblogKey: string,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Unlikes a post as the authenticating user

  Parameters

  • postId: string

    ID of post to like

  • reblogKey: string

    Reblog key of post to like

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

userDashboard

• userDashboard(
      paramsOrCallback?: Record<string, any> | TumblrClientCallback,
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the dashboard posts for the authenticating user

  Parameters

  • OptionalparamsOrCallback: Record<string, any> | TumblrClientCallback

    query parameters

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

userFollowing

• userFollowing(
      paramsOrCallback?:
          | TumblrClientCallback
          | { limit?: number; offset?: number },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the blogs the authenticating user follows

  Parameters

  • OptionalparamsOrCallback: TumblrClientCallback | { limit?: number; offset?: number }

    query parameters

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

userInfo

• userInfo(callback?: TumblrClientCallback): undefined | Promise<any>

  Gets information about the authenticating user and their blogs

  Parameters

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided

userLikes

• userLikes(
      paramsOrCallback?:
          | TumblrClientCallback
          | { after?: number; before?: number; limit?: number; offset?: number },
      callback?: TumblrClientCallback,
  ): undefined | Promise<any>

  Gets the likes for the authenticating user

  Parameters

  • OptionalparamsOrCallback:
        | TumblrClientCallback
        | { after?: number; before?: number; limit?: number; offset?: number }

    query parameters

  • Optionalcallback: TumblrClientCallback

    Deprecated Omit the callback and use the promise form

  Returns undefined | Promise<any>

  Promise if no callback is provided