@amityco/ts-sdk-react-native/src/cache/api/upsertInCache.ts

Amity Social Cloud Typescript SDK

import { getActiveClient } from '~/client/api/activeClient';

import { pullFromCache } from './pullFromCache';
import { pushToCache } from './pushToCache';
import { mergeInCache } from './mergeInCache';

/**
 * ```js
 * import { upsertInCache } from '@amityco/ts-sdk-react-native'
 * upsertInCache<Amity.InternalUser>(["user", "foobar"], user)
 * ```
 *
 * Insert or update any provided value as {@link Amity.CacheEntry} for
 * the matching {@link Amity.CacheKey}
 *
 * @param key the key to save the object to
 * @param data the object to save
 * @param options customisation object around cache behavior (default gives a 2mn lifespan)
 * @returns a success boolean if the object was saved in cache
 *
 * @category Cache API
 * @hidden
 */
export const upsertInCache = <T extends Record<string, unknown>>(
  key: Amity.CacheKey,
  data: T,
  options: Amity.CacheOptions = { cachedAt: Date.now() },
): boolean => {
  const { log, cache } = getActiveClient();

  if (!cache) return false;
  log('cache/api/upsertInCache', { key, data, options });

  const cached = pullFromCache<T>(key);

  return cached ? mergeInCache<T>(key, data, options) : pushToCache(key, data, options);
};