angular-cli-ghpages
- Version 3.0.1
- Published
- 128 kB
- 5 dependencies
- MIT license
Install
npm i angular-cli-ghpagesyarn add angular-cli-ghpagespnpm add angular-cli-ghpagesOverview
Deploy your Angular app to GitHub Pages or Cloudflare Pages directly from the Angular CLI (ng deploy)
Index
Variables
Functions
Interfaces
Type Aliases
Variables
variable defaults
const defaults: { dir: string; repo: undefined; message: string; branch: string; name: undefined; email: undefined; dotfiles: boolean; notfound: boolean; nojekyll: boolean; cname: undefined; add: boolean; dryRun: boolean; remote: string; git: string;};Functions
function angularDeploy
angularDeploy: ( engine: { run: ( dir: string, options: Schema, logger: logging.LoggerApi ) => Promise<void>; }, context: BuilderContext, buildTarget: BuildTarget, options: Schema) => Promise<void>;function appendCIMetadata
appendCIMetadata: (options: PreparedOptions) => void;function deployToGHPages
deployToGHPages: ( dir: string, options: PreparedOptions, logger: logging.LoggerApi) => Promise<void>;function executeDeploy
executeDeploy: ( options: Schema, context: BuilderContext) => Promise<BuilderOutput>;function handleUserCredentials
handleUserCredentials: ( options: PreparedOptions, origOptions: Schema, logger: logging.LoggerApi) => void;function injectTokenIntoRepoUrl
injectTokenIntoRepoUrl: (options: PreparedOptions) => Promise<void>;function isOutputPathObject
isOutputPathObject: (value: unknown) => value is AngularOutputPathObject;function mapNegatedBooleans
mapNegatedBooleans: (options: PreparedOptions, origOptions: Schema) => void;function ngAdd
ngAdd: ( options: NgAddOptions) => ( tree: Tree, context: SchematicContext) => Promise<import('@angular-devkit/schematics/src/tree/interface').Tree>;function prepareOptions
prepareOptions: ( origOptions: Schema, logger: logging.LoggerApi) => Promise<PreparedOptions>;function setupMonkeypatch
setupMonkeypatch: (logger: logging.LoggerApi) => void;function warnDeprecatedParameters
warnDeprecatedParameters: ( origOptions: Schema, logger: logging.LoggerApi) => void;Interfaces
interface AngularOutputPathObject
interface AngularOutputPathObject {}interface DeployUser
interface DeployUser {}interface GHPages
interface GHPages {}interface PublishOptions
interface PublishOptions {}property add
add?: boolean;property branch
branch?: string;property cname
cname?: string;property dotfiles
dotfiles?: boolean;property git
git?: string;property message
message?: string;property nojekyll
nojekyll?: boolean;property remote
remote?: string;property repo
repo?: string;property user
user?: { name: string; email: string;};index signature
[key: string]: unknown;Type Aliases
type AngularOutputPath
type AngularOutputPath = string | AngularOutputPathObject;type PreparedOptions
type PreparedOptions = Schema & { dotfiles: boolean; notfound: boolean; nojekyll: boolean; user?: { name: string; email: string; };};Package Files (8)
Dependencies (5)
Dev Dependencies (12)
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/angular-cli-ghpages.
- Markdown[](https://www.jsdocs.io/package/angular-cli-ghpages)
- HTML<a href="https://www.jsdocs.io/package/angular-cli-ghpages"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3337 ms. - Missing or incorrect documentation? Open an issue for this package.
