Closed erickzhao closed 1 month ago
Note that this PR doesn't actually set up any publishing for the website. I figured that could go into a follow-up PR where we set a GH Action similar to how electron/packager does it.
:tada: This PR is included in version 1.3.1 :tada:
The release is available on:
Your semantic-release bot :package::rocket:
This PR adds
typedoc
API documentation from our TypeScript types for the@electron/osx-sign
package.The module already had some pretty good API documentation available on the README.md, so the PR mostly moves the existing explanations around. This has the added bonus of providing better editor intellisense.
Goals:
README.md
examples from focusing on the legacy CLI to focusing on the JS API.Notes:
typedoc
works a lot better with TypeScript interfaces rather than types. For example,Omit<A, B>
will not be expanded into its underlying properties and will show up as-is by default intypedoc
.@interface
directive was added to a few types, and the coreSignOptions
andFlatOptions
types were re-exported as interfaces that extends the underlying types.Preview from my fork of this repo: https://erickzhao.github.io/osx-sign/