commonDocs.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
storybook/stories/common/commonDocs.ts	100.00%	95%	89	89	0

const getCanvasRenderingDoc = (name: string) => ({
  link: `https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/${name}`,
  name,
})

const getSVGElementDoc = (name: string) => ({
  link: `https://developer.mozilla.org/en-US/docs/Web/SVG/Element/${name}`,
  name: `${name} Element`,
})

const getSVGAttributeDoc = (name: string) => ({
  link: `https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/${name}`,
  name: `${name} attribute`,
})

const getThreeDoc = (path: string[]) => ({
  link: `https://threejs.org/docs/#api/en/${path.join("/")}`,
  name: `${path.join(".")} docs`,
})

const getThreeExampleDoc = (path: string[]) => ({
  link: `https://github.com/mrdoob/three.js/blob/dev/examples/jsm/${path.join(
    "/"
  )}.js`,
  name: `${path.join(".")} example source code`,
})

const webAPIDocs = {
  GLSLShaders: {
    link: "https://developer.mozilla.org/en-US/docs/Games/Techniques/3D_on_the_web/GLSL_Shaders",
    name: "GLSL Shaders",
  },
  pointerEvent: {
    link: "https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent",
    name: "PointerEvent",
  },
}

const canvasDocs = {
  arc: getCanvasRenderingDoc("arc"),
  beginPath: getCanvasRenderingDoc("beginPath"),
  clearRect: getCanvasRenderingDoc("clearRect"),
  getImageData: getCanvasRenderingDoc("getImageData"),
  globalCompositeOperation: getCanvasRenderingDoc("globalCompositeOperation"),
  strokeStyle: getCanvasRenderingDoc("strokeStyle"),
} as const

const svgDocs = {
  animateTransform: getSVGElementDoc("animateTransform"),
  begin: getSVGAttributeDoc("begin"),
  feConvolveMatrix: getSVGElementDoc("feConvolveMatrix"),
  feFlood: getSVGElementDoc("feFlood"),
  feMorphology: getSVGElementDoc("feMorphology"),
  fePointLight: getSVGElementDoc("fePointLight"),
} as const

const threeDocs = {
  canvasTexture: getThreeDoc(["textures", "CanvasTexture"]),
  color: getThreeDoc(["math", "color"]),
  improveNoiseExample: getThreeExampleDoc(["math", "ImprovedNoise"]),
  materialsConstants: getThreeDoc(["constants", "Materials"]),
  meshPhysicalMaterial: getThreeDoc(["materials", "MeshPhysicalMaterial"]),
  shaderMaterial: getThreeDoc(["materials", "ShaderMaterial"]),
  vector3: getThreeDoc(["math", "Vector3"]),
  webGLRenderer: getThreeDoc(["renderers", "WebGLRenderer"]),
}

export { canvasDocs, svgDocs, threeDocs, webAPIDocs }

[]

TypeScript Coverage Report generated by type-coverage and typescript-coverage-report at Wed, 01 Jun 2022 21:16:57 GMT

TypeScript coverage report