Skip to content

Commit

Permalink
readme: correcting da and @q issue
Browse files Browse the repository at this point in the history
  • Loading branch information
arthyn committed Apr 13, 2023
1 parent e630068 commit 15b1446
Showing 1 changed file with 33 additions and 30 deletions.
63 changes: 33 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,56 +6,59 @@ This NPM package is intended to ease the flow of developing FE applications for

```typescript
// @da manipulation
function parseDa(da: string): BigInteger
function formatDa(da: BigInteger): string
function parseDa(da: string): BigInteger;
function formatDa(da: BigInteger): string;
// Given a bigint representing an urbit date, returns a unix timestamp.
function daToUnix(da: BigInteger): number;
// Given a unix timestamp, returns a bigint representing an urbit date
function unixToDa(unix: number): BigInteger;

// @p manipulation
// Convert a number to a @p-encoded string.
function patp(arg: string | number | BigInteger): string
function hex2patp(hex: string): string
function patp2hex(name: string): string
function patp2bn(name: string): BigInteger
function patp2dec(name: string): string
function patp(arg: string | number | BigInteger): string;
function hex2patp(hex: string): string;
function patp2hex(name: string): string;
function patp2bn(name: string): BigInteger;
function patp2dec(name: string): string;
// Determine the ship class of a @p value.
function clan(who: string): string
function clan(who: string): string;
// Determine the parent of a @p value.
function sein(name: string): strin
function sein(name: string): strin;
// Validate a @p string.
function isValidPatp(str: string): boolean
function isValidPatp(str: string): boolean;
// Ensure @p is sigged.
function preSig(ship: string): string
function preSig(ship: string): string;
// Remove sig from @p
function deSig(ship: string): string
function deSig(ship: string): string;
// Trim @p to short form
function cite(ship: string): string | null
function cite(ship: string): string | null;

// @q manipulation
// Convert a number to a @q-encoded string.
function patq(arg: string | number | BigInteger): string
function hex2patq(arg: string): string
function patq2hex(name: string): string
function patq2bn(name: string): BigInteger
function patq2dec(name: string): string
function patq(arg: string | number | BigInteger): string;
function hex2patq(arg: string): string;
function patq2hex(name: string): string;
function patq2bn(name: string): BigInteger;
function patq2dec(name: string): string;
// Validate a @q string.
const isValidPatq = (str: string): boolean
function isValidPatq(str: string): boolean;
// Equality comparison on @q values.
function eqPatq(p: string, q: string): boolean
function eqPatq(p: string, q: string): boolean;

// @ud manipulation
function parseUd(ud: string): BigInteger
function formatUd(ud: BigInteger): string
function parseUd(ud: string): BigInteger;
function formatUd(ud: BigInteger): string;

// @uv manipulation
function parseUv(x: string): BigInteger
function formatUv(x: BigInteger | string): string
function parseUv(x: string): BigInteger;
function formatUv(x: BigInteger | string): string;

// @uw manipulation
function parseUw(x: string): BigInteger
function formatUw(x: BigInteger | string): string
function parseUw(x: string): BigInteger;
function formatUw(x: BigInteger | string): string;

// @ux manipulation
function parseUx(ux: string): string
function formatUx(hex: string): string
``

function parseUx(ux: string): string;
function formatUx(hex: string): string;
``;
```

0 comments on commit 15b1446

Please sign in to comment.