Namespace: shortString

Functions

isASCII

▸ isASCII(str): boolean

Test if string contains only ASCII characters (string can be ascii text)

Parameters

Name	Type
str	string

Returns

boolean

Defined in

src/utils/shortString.ts:8

---

isShortString

▸ isShortString(str): boolean

Test if string is a Cairo short string (string has less or equal 31 characters)

Parameters

Name	Type
str	string

Returns

boolean

Defined in

src/utils/shortString.ts:16

---

isDecimalString

▸ isDecimalString(str): boolean

Test if string contains only numbers (string can be converted to decimal number)

Parameters

Name	Type
str	string

Returns

boolean

Defined in

src/utils/shortString.ts:23

---

isString

▸ isString(value): value is string

Checks if a given value is a string.

Parameters

Name	Type	Description
value	unknown	The value to be checked.

Returns

value is string

• Returns true if the value is a string, false otherwise.

Defined in

src/utils/shortString.ts:33

---

isText

▸ isText(val): boolean

Test if value is a free-from string text, and not a hex string or number string

Parameters

Name	Type
val	any

Returns

boolean

Defined in

src/utils/shortString.ts:40

---

splitLongString

▸ splitLongString(longStr): string[]

Split long text into short strings

Parameters

Name	Type
longStr	string

Returns

string[]

Defined in

src/utils/shortString.ts:57

---

encodeShortString

▸ encodeShortString(str): string

Convert an ASCII string to a hexadecimal string.

Parameters

Name	Type	Description
str	string	short string (ASCII string, 31 characters max)

Returns

string

format: hex-string; 248 bits max

Example

const myEncodedString: string = encodeShortString("uri/pict/t38.jpg");
// return hex string (ex."0x7572692f706963742f7433382e6a7067")

Defined in

src/utils/shortString.ts:72

---

decodeShortString

▸ decodeShortString(str): string

Convert a hexadecimal or decimal string to an ASCII string.

Parameters

Name	Type	Description
str	string	representing a 248 bit max number (ex. "0x1A4F64EA56" or "236942575435676423")

Returns

string

format: short string; 31 characters max

Example

const myDecodedString: string = decodeShortString("0x7572692f706963742f7433382e6a7067");
// return string (ex."uri/pict/t38.jpg")

Defined in

src/utils/shortString.ts:88

---

isShortText

▸ isShortText(val): boolean

Test if value is short text

Parameters

Name	Type
val	any

Returns

boolean

Defined in

src/utils/shortString.ts:47

---

isLongText

▸ isLongText(val): boolean

Test if value is long text

Parameters

Name	Type
val	any

Returns

boolean

Defined in

src/utils/shortString.ts:52