@stackend/api/counter/index.d.ts

JS bindings to api.stackend.com

import { XcapJsonResult, Thunk, XcapOptionalParameters } from '../api';
/**
 * Xcap Counter API constants and methods.
 *
 * @since 27 jun 2017
 */
/**
 * Increment a counter.
 * Typically used to implement view counters.
 * Requires an authorized user. A user can only increment the counter once.
 *
 * @param context Context (Required)
 * @param referenceId Reference id, for example a blog entry id (Required)
 */
export declare function increment({ context, referenceId }: {
    context: string;
    referenceId: number;
} & XcapOptionalParameters): Thunk<Promise<XcapJsonResult>>;
/**
 * Make a footprint
 * Typically used to implement view counters.
 * Requires an authorized user. A user can only increment the counter once.
 *
 * @param context Context (Required)
 * @param referenceId Reference id, for example a blog entry id (Required)

 */
export declare function putFootprint({ context, referenceId }: {
    context: string;
    referenceId: number;
} & XcapOptionalParameters): Thunk<Promise<XcapJsonResult>>;
//# sourceMappingURL=index.d.ts.map