@stackend/api/api/CommunityContext.d.ts

JS bindings to api.stackend.com

/**
 * A community context represents a instance of some functionality,
 * for example comments, blog etc. Some functions may multiple instances,
 * like for example stand alone comments or comments on blog posts.
 */
export interface CommunityContext {
    /**
     * Community permalink, for example "xcap_c123"
     */
    community: string;
    /**
     * Context of the component, for example "comments"
     */
    context: string;
}
export default CommunityContext;
/**
 * Parse a community context.
 * @param communityContext
 * @returns {null|CommunityContext}
 */
export declare function parseCommunityContext(communityContext: string | null): CommunityContext | null;
/**
 * Get the string representation of a community context
 * @param communityContext
 */
export declare function communityContexToString(communityContext: CommunityContext | null): string | null;
//# sourceMappingURL=CommunityContext.d.ts.map