UNPKG

@subsocial/utils

Version:
61 lines (60 loc) 1.93 kB
import { SocialRemarkMessage, SocialRemarkMessageAction, SubSclSource } from './types'; import { SocialRemarkConfigData } from './config'; export declare class SocialRemark { private maybeRemarkMsg; /** * Set global config for all new SocialRemark instances * @param data: SocialRemarkConfigData */ static setConfig(data: SocialRemarkConfigData): void; private msgParsed; private protNames; private versions; private destinations; private actions; private msgDelimiter; /** * Get SocialRemark full data, if it's available. Otherwise, go throw error. */ get source(): SocialRemarkMessage<SocialRemarkMessageAction, boolean> | never; /** * Get SocialRemark instance source content, if it's valid and available. */ get content(): import("./types").DomainRegisterPayContent | import("./types").EnergyGeneratePayContent | null; /** * Get SocialRemark instance version, if it's valid and available. */ get version(): "0.1" | null; /** * Is SocialRemark valid. */ get isValidMessage(): boolean; /** * Convert bytes to string. * @param src: unknown */ static bytesToString(src: unknown): string; /** * Create SocialRemark from raw string remark message. * @param maybeRemarkMsg: unknown */ fromMessage(maybeRemarkMsg: unknown): SocialRemark; /** * Create SocialRemark from source map. * @param rmrkSrc: SubSclSource<SocialRemarkMessageAction> */ fromSource(rmrkSrc: SubSclSource<SocialRemarkMessageAction>): SocialRemark; /** * Encode SocialRemark source to remark string. */ toMessage(): string; /** * ====== Private functionality ====== */ private parseMsg; private isValidProtName; private isValidVersion; private isValidDestination; private isValidAction; private isRemarkSourceValid; }