Skip to main content

damoa-webview-bridge

앱과 웹 사이에 data communication 을 위해 사용되는 라이브러리로써 type guard, 메시지별 하위버전 지원가능성 체크, 비동기 메시지 응답, 버저닝 등의 기능을 제공한다. 노션문서

documentation​

요약​

documentation은 typedoc + docusaurus로 제작되었습니다. production branch(main)에 commit push시에 githubAction에 의해 https://damoa-webview-bridge-doc-dance.vercel.app 에 자동배포됩니다.

로컬 실행방법​

패키지 루트 디렉토리에서 아래 명령어를 실행시켜주세요.

    yarn prepare-doc
    yarn start-doc

문서화 방법​

각 메시지에 typedoc의 기본 포맷에 따라 comment를 추가해주세요.
vscode의 경우 snippet을 이용하시면 보다쉽게 메시지를 작성하실 수 있습니다. 아래는 custom snippet 명령어입니다.

  • webToAppMessage
  • webToAppAsyncMessage
  • appToWebMessage