react-docgen/dist/utils/flowUtilityTypes.js

A CLI and toolkit to extract information from React components for documentation generation.

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.isSupportedUtilityType = isSupportedUtilityType;
exports.unwrapUtilityType = unwrapUtilityType;

var _recast = _interopRequireDefault(require("recast"));

/*
 * Copyright (c) 2015, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * 
 *
 */
const types = _recast.default.types.namedTypes;
const supportedUtilityTypes = new Set(['$Exact', '$ReadOnly']);
/**
 * See `supportedUtilityTypes` for which types are supported and
 * https://flow.org/en/docs/types/utilities/ for which types are available.
 */

function isSupportedUtilityType(path) {
  if (types.GenericTypeAnnotation.check(path.node)) {
    const idPath = path.get('id');
    return Boolean(idPath) && supportedUtilityTypes.has(idPath.node.name);
  }

  return false;
}
/**
 * Unwraps well known utility types. For example:
 *
 *   $ReadOnly<T> => T
 */


function unwrapUtilityType(path) {
  return path.get('typeParameters', 'params', 0);
}