Skip to main content

PrimaryKeyParser

Parses a Primary Key for the provided Table.

Given an input of any type, validates that it respects the primary key schema of the Table and throws an error otherwise. Additional fields are silently omitted, but the input is not mutated:

import { PrimaryKeyParser } from 'dynamodb-toolbox/table/actions/parsePrimaryKey'

const primaryKeyParser = PokeTable.build(PrimaryKeyParser)

const primaryKey = primaryKeyParser.parse({
  partitionKey: 'pikachu',
  sortKey: 42,
  foo: 'bar'
})
// ✅ => { partitionKey: 'pikachu', sortKey: 42 }

primaryKeyParser.parse({ invalid: 'input' })
// ❌ Throws an 'actions.parsePrimaryKey.invalidKeyPart' error
info

Only the presence and types of the primary key components are validated. Since the primary key schema of a Table is not technically an instance of Schema, no default, link, or transform is applied.

Output​

The output is typed as the primary key of the table.

You can use the PrimaryKey type to explicitly type an object as a primary key object:

import type { PrimaryKey } from 'dynamodb-toolbox/table/actions/parsePrimaryKey'

type PokeKey = PrimaryKey<typeof PokeTable>
// => { partitionKey: string, sortKey: number }