All files / src/handlers flowTypeHandler.js

100% Statements 10/10
75% Branches 3/4
100% Functions 3/3
100% Lines 10/10
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46                                          25x 25x 25x 25x 25x                   28x   28x 14x     14x 25x      
/*
 * 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.
 *
 * @flow
 *
 */
 
import type Documentation from '../Documentation';
 
import getFlowType from '../utils/getFlowType';
import getPropertyName from '../utils/getPropertyName';
import getFlowTypeFromReactComponent, {
  applyToFlowTypeProperties,
}  from '../utils/getFlowTypeFromReactComponent';
 
function setPropDescriptor(documentation: Documentation, path: NodePath): void {
  const propDescriptor = documentation.getPropDescriptor(getPropertyName(path));
  const type = getFlowType(path.get('value'));
  Eif (type) {
    propDescriptor.flowType = type;
    propDescriptor.required = !path.node.optional;
  }
}
 
/**
 * This handler tries to find flow Type annotated react components and extract
 * its types to the documentation. It also extracts docblock comments which are
 * inlined in the type definition.
 */
export default function flowTypeHandler(documentation: Documentation, path: NodePath) {
  let flowTypesPath = getFlowTypeFromReactComponent(path);
 
  if (!flowTypesPath) {
    return;
  }
 
  applyToFlowTypeProperties(flowTypesPath, propertyPath => {
      setPropDescriptor(documentation, propertyPath)
  });
}