@waline/client/src/api/pageview.ts

client for waline comment system

import { getArticleCounter, updateArticleCounter } from './articleCounter';
import type { BaseAPIOptions } from './utils';

interface GetPageviewOptions extends BaseAPIOptions {
  /**
   * 待获取页面的 path
   *
   * Path of pages
   */
  paths: string[];

  /**
   * 取消请求的信号
   *
   * AbortSignal to cancel request
   */
  signal?: AbortSignal;
}

export const getPageview = ({
  serverURL,
  lang,
  paths,
  signal,
}: GetPageviewOptions): Promise<number[]> =>
  getArticleCounter({
    serverURL,
    lang,
    paths,
    type: ['time'],
    signal,
  })
    // TODO: Improve this API
    .then((counts) => (Array.isArray(counts) ? counts : [counts])) as Promise<
    number[]
  >;

export interface UpdatePageviewOptions extends BaseAPIOptions {
  /**
   * 待更新页面的 path
   *
   * Path of pages
   */
  path: string;
}

export const updatePageview = (
  options: UpdatePageviewOptions
): Promise<number> =>
  updateArticleCounter({
    ...options,
    type: 'time',
    action: 'inc',
  });