isOffchainMessageApplicationDomain

function isOffchainMessageApplicationDomain(
    putativeApplicationDomain,
): putativeApplicationDomain is OffchainMessageApplicationDomain;

A type guard that returns true if the input string conforms to the OffchainMessageApplicationDomain type, and refines its type for use in your program.

Parameters

ParameterType
putativeApplicationDomainstring

Returns

putativeApplicationDomain is OffchainMessageApplicationDomain

Example

import { isOffchainMessageApplicationDomain, OffchainMessageV0 } from '@solana/offchain-messages';
 
if (isOffchainMessageApplicationDomain(applicationDomain)) {
    // At this point, `applicationDomain` has been refined to an
    // `OffchainMessageApplcationDomain` that can be used to craft a message.
    const offchainMessage: OffchainMessageV0 = {
        applicationDomain:
            offchainMessageApplicationDomain('HgHLLXT3BVA5m7x66tEp3YNatXLth1hJwVeCva2T9RNx'),
            // ...
    };
} else {
    setError(`${applicationDomain} is not a valid application domain for an offchain message`);
}

On this page