Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

@atcute/pckt

pckt (blog.pckt.*) schema definitions

npm install @atcute/pckt

usage

import { BlogPcktPublication } from '@atcute/pckt';
import { is } from '@atcute/lexicons';

const publication: BlogPcktPublication.Main = {
	$type: 'blog.pckt.publication',
	publication: {
		uri: 'at://did:plc:z72i7hdynmk6r22z27h6tvur/site.standard.publication/3mcrfiixja3uw',
		cid: 'bafyreih2jc2tysdwsw4r3rq5rcbagu7mmpmvguqffjup4px5bwsxljcqo4',
	},
};

is(BlogPcktPublication.mainSchema, publication);
// -> true

with @atcute/client

pick either one of these 3 options to register the ambient declarations

// file: tsconfig.json
{
	"compilerOptions": {
		"types": ["@atcute/pckt"],
	},
}
// file: env.d.ts
/// <reference types="@atcute/pckt" />
// file: index.ts
import type {} from '@atcute/pckt';

with @atcute/lex-cli

when building your own lexicons that reference pckt types, configure lex-cli to import from this package:

// file: lex.config.js
import { defineLexiconConfig } from '@atcute/lex-cli';

export default defineLexiconConfig({
	files: ['lexicons/**/*.json'],
	outdir: 'src/lexicons/',
	imports: ['@atcute/pckt'],
});