Home/Tools/@tpmjs/official-base64-decode

base64DecodeTool

@tpmjs/official-base64-decode

Decode base64 encoded data to string. Supports utf8 (default), binary, and hex output encodings. Returns the decoded string and the byte length of the decoded data.

Official
data
v0.1.0
MIT

Interactive Playground

Test @tpmjs/official-base64-decode (base64DecodeTool) with AI-powered execution

0/2000 characters

Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/official-base64-decode
pnpm add @tpmjs/official-base64-decode
yarn add @tpmjs/official-base64-decode
bun add @tpmjs/official-base64-decode
deno add npm:@tpmjs/official-base64-decode

2. Import the tool

import { base64DecodeTool } from '@tpmjs/official-base64-decode';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { base64DecodeTool } from '@tpmjs/official-base64-decode';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { base64DecodeTool },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Parameters

Available configuration options

Auto-extracted
base64
Required
Type: string

The base64 encoded data to decode

encoding
Optional
Type: string

Character encoding for the output data (default: utf8)

Schema extracted: 1/1/2026, 8:17:40 AM

README

@tpmjs/official-base64-decode

Decode base64 encoded data to string with support for multiple output encodings.

Installation

npm install @tpmjs/official-base64-decode

Usage

import { base64DecodeTool } from '@tpmjs/official-base64-decode';
import { generateText } from 'ai';

const result = await generateText({
  model: yourModel,
  tools: {
    base64Decode: base64DecodeTool,
  },
  prompt: 'Decode the base64 string "SGVsbG8sIFdvcmxkIQ=="',
});

Parameters

  • base64 (string, required): The base64 encoded data to decode
  • encoding (string, optional): Character encoding for the output data
    • Options: 'utf8' (default), 'binary', 'hex'

Returns

{
  decoded: string;       // The decoded string
  byteLength: number;    // The byte length of the decoded data
}

Examples

Decode to UTF-8 text (default)

const result = await base64DecodeTool.execute({
  base64: 'SGVsbG8sIFdvcmxkIQ==',
});
// { decoded: 'Hello, World!', byteLength: 13 }

Decode to hex string

const result = await base64DecodeTool.execute({
  base64: '3q2+7w==',
  encoding: 'hex',
});
// { decoded: 'deadbeef', byteLength: 4 }

Decode to binary

const result = await base64DecodeTool.execute({
  base64: 'AAECAw==',
  encoding: 'binary',
});
// { decoded: '\x00\x01\x02\x03', byteLength: 4 }

Use Cases

  • Decoding base64-encoded API responses
  • Extracting data from data URIs
  • Decoding authentication tokens
  • Processing base64-encoded file content
  • Converting base64 images back to binary

Error Handling

The tool throws an error if:

  • The base64 string is invalid
  • The encoding parameter is not one of the supported values

License

MIT

Statistics

Downloads/month

0

Quality Score

0%

Bundle Size

NPM Keywords

tpmjs
data
base64
decode
encoding

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai