Home/Tools/@tpmjs/official-offer-letter-draft

offerLetterDraftTool

@tpmjs/official-offer-letter-draft

Generates offer letter content from compensation and role details

Official
hr
v0.1.1
MIT

Interactive Playground

Test @tpmjs/official-offer-letter-draft (offerLetterDraftTool) 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-offer-letter-draft
pnpm add @tpmjs/official-offer-letter-draft
yarn add @tpmjs/official-offer-letter-draft
bun add @tpmjs/official-offer-letter-draft
deno add npm:@tpmjs/official-offer-letter-draft

2. Import the tool

import { offerLetterDraftTool } from '@tpmjs/official-offer-letter-draft';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { offerLetterDraftTool } from '@tpmjs/official-offer-letter-draft';

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

console.log(result.text);

Signature

(role: { type: string; title: string; manager: string; isRemote: boolean; location: string }, offer: { bonus: { type: string; target: number }; equity: { shares: number; percentage: number; vestingYears: number }; salary: number; benefits: string[]; currency: string }, candidate: { name: string; email: string; address: string }) => Promise<unknown>

Tags

compensation
content
details
draft
generates
hiring
hr
letter
offer
offer-letter
official
role
tpmjs

Parameters

Available configuration options

Auto-extracted
candidate
Required
Type: object

Candidate information (name, address)

offer
Required
Type: object

Offer details (salary, equity, benefits)

role
Required
Type: object

Role details (title, department, manager)

Schema extracted: 3/1/2026, 4:28:01 AM

README

ERROR: No README data found!

Statistics

Downloads/month

0

Quality Score

0%

Bundle Size

NPM Keywords

tpmjs
hr
offer-letter
hiring
compensation

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai