From c36034d33e68b86c4707af4c44d1e0e6b4f3c541 Mon Sep 17 00:00:00 2001 From: Gabriel Csapo Date: Thu, 11 Aug 2022 00:49:12 -0700 Subject: [PATCH] feat(docs): improve API output using docusaurus-plugin-typedoc-api --- tsdoc-metadata.json | 11 - website/api-documenter.json | 9 - website/api-extractor.json | 151 -- website/docs/api/_category_.json | 3 - website/docs/api/api-sidebar.js | 1217 ----------------- website/docs/api/index.md | 19 - website/docs/api/node-git-server.basicauth.md | 32 - .../docs/api/node-git-server.createaction.md | 32 - .../api/node-git-server.fetchdata.commit.md | 18 - website/docs/api/node-git-server.fetchdata.md | 29 - .../api/node-git-server.fetchdata.repo.md | 18 - .../api/node-git-server.git._constructor_.md | 27 - .../api/node-git-server.git.authenticate.md | 18 - .../api/node-git-server.git.autocreate.md | 18 - .../docs/api/node-git-server.git.checkout.md | 18 - website/docs/api/node-git-server.git.close.md | 24 - .../docs/api/node-git-server.git.create.md | 31 - .../docs/api/node-git-server.git.dirmap.md | 18 - .../docs/api/node-git-server.git.exists.md | 30 - .../docs/api/node-git-server.git.gettype.md | 30 - .../docs/api/node-git-server.git.handle.md | 31 - website/docs/api/node-git-server.git.list.md | 30 - .../docs/api/node-git-server.git.list_1.md | 22 - .../docs/api/node-git-server.git.listen.md | 32 - website/docs/api/node-git-server.git.md | 52 - website/docs/api/node-git-server.git.mkdir.md | 30 - .../docs/api/node-git-server.git.server.md | 18 - ...t-server.gitauthenticateoptions.headers.md | 18 - .../node-git-server.gitauthenticateoptions.md | 27 - ...-git-server.gitauthenticateoptions.repo.md | 18 - ...-git-server.gitauthenticateoptions.type.md | 18 - ...-git-server.gitauthenticateoptions.user.md | 18 - website/docs/api/node-git-server.gitevents.md | 28 - .../docs/api/node-git-server.gitevents.on.md | 37 - .../api/node-git-server.gitevents.on_1.md | 35 - .../api/node-git-server.gitevents.on_2.md | 37 - .../api/node-git-server.gitevents.on_3.md | 37 - .../api/node-git-server.gitevents.on_4.md | 37 - ...node-git-server.gitoptions.authenticate.md | 18 - .../node-git-server.gitoptions.autocreate.md | 18 - .../node-git-server.gitoptions.checkout.md | 18 - .../docs/api/node-git-server.gitoptions.md | 26 - website/docs/api/node-git-server.headdata.md | 28 - .../docs/api/node-git-server.headdata.repo.md | 18 - ...ode-git-server.httpduplex._constructor_.md | 40 - .../api/node-git-server.httpduplex.accept.md | 22 - .../node-git-server.httpduplex.complete.md | 18 - .../node-git-server.httpduplex.connection.md | 20 - .../api/node-git-server.httpduplex.cork.md | 28 - .../api/node-git-server.httpduplex.cwd.md | 18 - .../api/node-git-server.httpduplex.destroy.md | 22 - .../api/node-git-server.httpduplex.end.md | 28 - .../api/node-git-server.httpduplex.exists.md | 18 - .../api/node-git-server.httpduplex.headers.md | 20 - .../node-git-server.httpduplex.httpversion.md | 20 - ...-git-server.httpduplex.httpversionmajor.md | 20 - ...-git-server.httpduplex.httpversionminor.md | 20 - .../docs/api/node-git-server.httpduplex.md | 63 - .../api/node-git-server.httpduplex.method.md | 24 - .../node-git-server.httpduplex.readable.md | 20 - .../api/node-git-server.httpduplex.reject.md | 29 - .../api/node-git-server.httpduplex.repo.md | 18 - .../api/node-git-server.httpduplex.req.md | 20 - .../api/node-git-server.httpduplex.res.md | 20 - .../node-git-server.httpduplex.setheader.md | 29 - .../api/node-git-server.httpduplex.socket.md | 20 - .../node-git-server.httpduplex.statuscode.md | 26 - ...ode-git-server.httpduplex.statusmessage.md | 26 - .../node-git-server.httpduplex.trailers.md | 20 - .../api/node-git-server.httpduplex.uncork.md | 24 - .../api/node-git-server.httpduplex.url.md | 28 - .../node-git-server.httpduplex.writable.md | 18 - .../node-git-server.httpduplex.writehead.md | 36 - website/docs/api/node-git-server.infodata.md | 28 - .../docs/api/node-git-server.infodata.repo.md | 18 - .../docs/api/node-git-server.inforesponse.md | 34 - website/docs/api/node-git-server.md | 52 - website/docs/api/node-git-server.nocache.md | 30 - .../docs/api/node-git-server.packsideband.md | 28 - .../docs/api/node-git-server.parsegitname.md | 30 - .../api/node-git-server.pushdata.branch.md | 18 - .../api/node-git-server.pushdata.commit.md | 18 - website/docs/api/node-git-server.pushdata.md | 30 - .../docs/api/node-git-server.pushdata.repo.md | 18 - .../node-git-server.service._constructor_.md | 28 - .../api/node-git-server.service.accept.md | 24 - .../api/node-git-server.service.commit.md | 18 - .../docs/api/node-git-server.service.cwd.md | 18 - .../api/node-git-server.service.evname.md | 18 - .../docs/api/node-git-server.service.last.md | 18 - .../docs/api/node-git-server.service.log.md | 22 - .../docs/api/node-git-server.service.logs.md | 18 - website/docs/api/node-git-server.service.md | 48 - .../api/node-git-server.service.reject.md | 31 - .../docs/api/node-git-server.service.repo.md | 18 - .../api/node-git-server.service.service.md | 18 - .../api/node-git-server.service.status.md | 18 - .../api/node-git-server.service.username.md | 18 - .../api/node-git-server.serviceoptions.cwd.md | 18 - .../api/node-git-server.serviceoptions.md | 26 - .../node-git-server.serviceoptions.repo.md | 18 - .../node-git-server.serviceoptions.service.md | 18 - .../api/node-git-server.servicerespond.md | 33 - .../docs/api/node-git-server.servicestring.md | 18 - .../api/node-git-server.tagdata.commit.md | 18 - website/docs/api/node-git-server.tagdata.md | 30 - .../docs/api/node-git-server.tagdata.repo.md | 18 - .../api/node-git-server.tagdata.version.md | 18 - website/docusaurus.config.js | 16 +- website/package.json | 20 +- website/sidebars.js | 20 - website/tsdoc-metadata.json | 11 - 112 files changed, 18 insertions(+), 4002 deletions(-) delete mode 100644 tsdoc-metadata.json delete mode 100644 website/api-documenter.json delete mode 100644 website/api-extractor.json delete mode 100644 website/docs/api/_category_.json delete mode 100644 website/docs/api/api-sidebar.js delete mode 100644 website/docs/api/index.md delete mode 100644 website/docs/api/node-git-server.basicauth.md delete mode 100644 website/docs/api/node-git-server.createaction.md delete mode 100644 website/docs/api/node-git-server.fetchdata.commit.md delete mode 100644 website/docs/api/node-git-server.fetchdata.md delete mode 100644 website/docs/api/node-git-server.fetchdata.repo.md delete mode 100644 website/docs/api/node-git-server.git._constructor_.md delete mode 100644 website/docs/api/node-git-server.git.authenticate.md delete mode 100644 website/docs/api/node-git-server.git.autocreate.md delete mode 100644 website/docs/api/node-git-server.git.checkout.md delete mode 100644 website/docs/api/node-git-server.git.close.md delete mode 100644 website/docs/api/node-git-server.git.create.md delete mode 100644 website/docs/api/node-git-server.git.dirmap.md delete mode 100644 website/docs/api/node-git-server.git.exists.md delete mode 100644 website/docs/api/node-git-server.git.gettype.md delete mode 100644 website/docs/api/node-git-server.git.handle.md delete mode 100644 website/docs/api/node-git-server.git.list.md delete mode 100644 website/docs/api/node-git-server.git.list_1.md delete mode 100644 website/docs/api/node-git-server.git.listen.md delete mode 100644 website/docs/api/node-git-server.git.md delete mode 100644 website/docs/api/node-git-server.git.mkdir.md delete mode 100644 website/docs/api/node-git-server.git.server.md delete mode 100644 website/docs/api/node-git-server.gitauthenticateoptions.headers.md delete mode 100644 website/docs/api/node-git-server.gitauthenticateoptions.md delete mode 100644 website/docs/api/node-git-server.gitauthenticateoptions.repo.md delete mode 100644 website/docs/api/node-git-server.gitauthenticateoptions.type.md delete mode 100644 website/docs/api/node-git-server.gitauthenticateoptions.user.md delete mode 100644 website/docs/api/node-git-server.gitevents.md delete mode 100644 website/docs/api/node-git-server.gitevents.on.md delete mode 100644 website/docs/api/node-git-server.gitevents.on_1.md delete mode 100644 website/docs/api/node-git-server.gitevents.on_2.md delete mode 100644 website/docs/api/node-git-server.gitevents.on_3.md delete mode 100644 website/docs/api/node-git-server.gitevents.on_4.md delete mode 100644 website/docs/api/node-git-server.gitoptions.authenticate.md delete mode 100644 website/docs/api/node-git-server.gitoptions.autocreate.md delete mode 100644 website/docs/api/node-git-server.gitoptions.checkout.md delete mode 100644 website/docs/api/node-git-server.gitoptions.md delete mode 100644 website/docs/api/node-git-server.headdata.md delete mode 100644 website/docs/api/node-git-server.headdata.repo.md delete mode 100644 website/docs/api/node-git-server.httpduplex._constructor_.md delete mode 100644 website/docs/api/node-git-server.httpduplex.accept.md delete mode 100644 website/docs/api/node-git-server.httpduplex.complete.md delete mode 100644 website/docs/api/node-git-server.httpduplex.connection.md delete mode 100644 website/docs/api/node-git-server.httpduplex.cork.md delete mode 100644 website/docs/api/node-git-server.httpduplex.cwd.md delete mode 100644 website/docs/api/node-git-server.httpduplex.destroy.md delete mode 100644 website/docs/api/node-git-server.httpduplex.end.md delete mode 100644 website/docs/api/node-git-server.httpduplex.exists.md delete mode 100644 website/docs/api/node-git-server.httpduplex.headers.md delete mode 100644 website/docs/api/node-git-server.httpduplex.httpversion.md delete mode 100644 website/docs/api/node-git-server.httpduplex.httpversionmajor.md delete mode 100644 website/docs/api/node-git-server.httpduplex.httpversionminor.md delete mode 100644 website/docs/api/node-git-server.httpduplex.md delete mode 100644 website/docs/api/node-git-server.httpduplex.method.md delete mode 100644 website/docs/api/node-git-server.httpduplex.readable.md delete mode 100644 website/docs/api/node-git-server.httpduplex.reject.md delete mode 100644 website/docs/api/node-git-server.httpduplex.repo.md delete mode 100644 website/docs/api/node-git-server.httpduplex.req.md delete mode 100644 website/docs/api/node-git-server.httpduplex.res.md delete mode 100644 website/docs/api/node-git-server.httpduplex.setheader.md delete mode 100644 website/docs/api/node-git-server.httpduplex.socket.md delete mode 100644 website/docs/api/node-git-server.httpduplex.statuscode.md delete mode 100644 website/docs/api/node-git-server.httpduplex.statusmessage.md delete mode 100644 website/docs/api/node-git-server.httpduplex.trailers.md delete mode 100644 website/docs/api/node-git-server.httpduplex.uncork.md delete mode 100644 website/docs/api/node-git-server.httpduplex.url.md delete mode 100644 website/docs/api/node-git-server.httpduplex.writable.md delete mode 100644 website/docs/api/node-git-server.httpduplex.writehead.md delete mode 100644 website/docs/api/node-git-server.infodata.md delete mode 100644 website/docs/api/node-git-server.infodata.repo.md delete mode 100644 website/docs/api/node-git-server.inforesponse.md delete mode 100644 website/docs/api/node-git-server.md delete mode 100644 website/docs/api/node-git-server.nocache.md delete mode 100644 website/docs/api/node-git-server.packsideband.md delete mode 100644 website/docs/api/node-git-server.parsegitname.md delete mode 100644 website/docs/api/node-git-server.pushdata.branch.md delete mode 100644 website/docs/api/node-git-server.pushdata.commit.md delete mode 100644 website/docs/api/node-git-server.pushdata.md delete mode 100644 website/docs/api/node-git-server.pushdata.repo.md delete mode 100644 website/docs/api/node-git-server.service._constructor_.md delete mode 100644 website/docs/api/node-git-server.service.accept.md delete mode 100644 website/docs/api/node-git-server.service.commit.md delete mode 100644 website/docs/api/node-git-server.service.cwd.md delete mode 100644 website/docs/api/node-git-server.service.evname.md delete mode 100644 website/docs/api/node-git-server.service.last.md delete mode 100644 website/docs/api/node-git-server.service.log.md delete mode 100644 website/docs/api/node-git-server.service.logs.md delete mode 100644 website/docs/api/node-git-server.service.md delete mode 100644 website/docs/api/node-git-server.service.reject.md delete mode 100644 website/docs/api/node-git-server.service.repo.md delete mode 100644 website/docs/api/node-git-server.service.service.md delete mode 100644 website/docs/api/node-git-server.service.status.md delete mode 100644 website/docs/api/node-git-server.service.username.md delete mode 100644 website/docs/api/node-git-server.serviceoptions.cwd.md delete mode 100644 website/docs/api/node-git-server.serviceoptions.md delete mode 100644 website/docs/api/node-git-server.serviceoptions.repo.md delete mode 100644 website/docs/api/node-git-server.serviceoptions.service.md delete mode 100644 website/docs/api/node-git-server.servicerespond.md delete mode 100644 website/docs/api/node-git-server.servicestring.md delete mode 100644 website/docs/api/node-git-server.tagdata.commit.md delete mode 100644 website/docs/api/node-git-server.tagdata.md delete mode 100644 website/docs/api/node-git-server.tagdata.repo.md delete mode 100644 website/docs/api/node-git-server.tagdata.version.md delete mode 100644 website/sidebars.js delete mode 100644 website/tsdoc-metadata.json diff --git a/tsdoc-metadata.json b/tsdoc-metadata.json deleted file mode 100644 index 5e804b3..0000000 --- a/tsdoc-metadata.json +++ /dev/null @@ -1,11 +0,0 @@ -// This file is read by tools that parse documentation comments conforming to the TSDoc standard. -// It should be published with your NPM package. It should not be tracked by Git. -{ - "tsdocVersion": "0.12", - "toolPackages": [ - { - "packageName": "@microsoft/api-extractor", - "packageVersion": "7.18.19" - } - ] -} diff --git a/website/api-documenter.json b/website/api-documenter.json deleted file mode 100644 index 68b35d4..0000000 --- a/website/api-documenter.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "outputTarget": "markdown", - "plugins": [ - { - "packageName": "docusaurus-plugin-api-extractor-markdown-documenter", - "enabledFeatureNames": ["docusaurus-plugin-api-extractor-markdown-documenter"] - } - ] - } \ No newline at end of file diff --git a/website/api-extractor.json b/website/api-extractor.json deleted file mode 100644 index bc9c423..0000000 --- a/website/api-extractor.json +++ /dev/null @@ -1,151 +0,0 @@ -/** - * Config file for API Extractor. For more info, please visit: https://api-extractor.com - */ - { - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - "mainEntryPointFilePath": "/dist/index.d.ts", - - "apiReport": { - "enabled": true, - "reportFileName": "node-git-server.api.md" - }, - - "docModel": { - "enabled": true, - "apiJsonFilePath": "/temp/node-git-server.api.json" - }, - - "dtsRollup": { - "enabled": true, - "untrimmedFilePath": "/dist/node-git-server.d.ts" - }, - - /** - * Configures how the tsdoc-metadata.json file will be generated. - */ - "tsdocMetadata": { - /** - * Whether to generate the tsdoc-metadata.json file. - * - * DEFAULT VALUE: true - */ - // "enabled": true, - /** - * Specifies where the TSDoc metadata file should be written. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * The default value is "", which causes the path to be automatically inferred from the "tsdocMetadata", - * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup - * falls back to "tsdoc-metadata.json" in the package folder. - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "" - */ - // "tsdocMetadataFilePath": "/dist/tsdoc-metadata.json" - }, - - /** - * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files - * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead. - * To use the OS's default newline kind, specify "os". - * - * DEFAULT VALUE: "crlf" - */ - // "newlineKind": "crlf", - - /** - * Configures how API Extractor reports error and warning messages produced during analysis. - * - * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages. - */ - "messages": { - /** - * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing - * the input .d.ts files. - * - * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551" - * - * DEFAULT VALUE: A single "default" entry with logLevel=warning. - */ - "compilerMessageReporting": { - /** - * Configures the default routing for messages that don't match an explicit rule in this table. - */ - "default": { - /** - * Specifies whether the message should be written to the the tool's output log. Note that - * the "addToApiReportFile" property may supersede this option. - * - * Possible values: "error", "warning", "none" - * - * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail - * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes - * the "--local" option), the warning is displayed but the build will not fail. - * - * DEFAULT VALUE: "warning" - */ - "logLevel": "warning" - - /** - * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), - * then the message will be written inside that file; otherwise, the message is instead logged according to - * the "logLevel" option. - * - * DEFAULT VALUE: false - */ - // "addToApiReportFile": false - } - - // "TS2551": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - }, - - /** - * Configures handling of messages reported by API Extractor during its analysis. - * - * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag" - * - * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings - */ - "extractorMessageReporting": { - "default": { - "logLevel": "warning" - // "addToApiReportFile": false - } - - // "ae-extra-release-tag": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - }, - - /** - * Configures handling of messages reported by the TSDoc parser when analyzing code comments. - * - * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text" - * - * DEFAULT VALUE: A single "default" entry with logLevel=warning. - */ - "tsdocMessageReporting": { - "default": { - "logLevel": "warning" - // "addToApiReportFile": false - } - - // "tsdoc-link-tag-unescaped-text": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - } - } -} \ No newline at end of file diff --git a/website/docs/api/_category_.json b/website/docs/api/_category_.json deleted file mode 100644 index 38c866f..0000000 --- a/website/docs/api/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "API" -} \ No newline at end of file diff --git a/website/docs/api/api-sidebar.js b/website/docs/api/api-sidebar.js deleted file mode 100644 index e4b2001..0000000 --- a/website/docs/api/api-sidebar.js +++ /dev/null @@ -1,1217 +0,0 @@ -// Do not edit this file. It is automatically generated by docusaurus-plugin-api-extractor. -module.exports = (dir = 'api') => [ - { - type: 'category', - label: 'Packages', - collapsed: false, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/index`, - }, - { - type: 'category', - label: 'node-git-server', - collapsed: false, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server`, - }, - { - type: 'doc', - label: 'basicAuth', - id: `${dir}/node-git-server.basicauth`, - }, - { - type: 'doc', - label: 'createAction', - id: `${dir}/node-git-server.createaction`, - }, - { - type: 'category', - label: 'FetchData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.fetchdata`, - }, - { - type: 'doc', - label: 'commit', - id: `${dir}/node-git-server.fetchdata.commit`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.fetchdata.repo`, - }, - ], - }, - { - type: 'category', - label: 'Git', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.git`, - }, - { - type: 'doc', - label: '(constructor)', - id: `${dir}/node-git-server.git._constructor_`, - }, - { - type: 'doc', - label: 'authenticate', - id: `${dir}/node-git-server.git.authenticate`, - }, - { - type: 'doc', - label: 'autoCreate', - id: `${dir}/node-git-server.git.autocreate`, - }, - { - type: 'doc', - label: 'checkout', - id: `${dir}/node-git-server.git.checkout`, - }, - { - type: 'doc', - label: 'close', - id: `${dir}/node-git-server.git.close`, - }, - { - type: 'doc', - label: 'create', - id: `${dir}/node-git-server.git.create`, - }, - { - type: 'doc', - label: 'dirMap', - id: `${dir}/node-git-server.git.dirmap`, - }, - { - type: 'doc', - label: 'exists', - id: `${dir}/node-git-server.git.exists`, - }, - { - type: 'doc', - label: 'getType', - id: `${dir}/node-git-server.git.gettype`, - }, - { - type: 'doc', - label: 'handle', - id: `${dir}/node-git-server.git.handle`, - }, - { - type: 'doc', - label: 'list', - id: `${dir}/node-git-server.git.list`, - }, - { - type: 'doc', - label: 'list', - id: `${dir}/node-git-server.git.list_1`, - }, - { - type: 'doc', - label: 'listen', - id: `${dir}/node-git-server.git.listen`, - }, - { - type: 'doc', - label: 'mkdir', - id: `${dir}/node-git-server.git.mkdir`, - }, - { - type: 'doc', - label: 'server', - id: `${dir}/node-git-server.git.server`, - }, - ], - }, - { - type: 'category', - label: 'GitAuthenticateOptions', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.gitauthenticateoptions`, - }, - { - type: 'doc', - label: 'headers', - id: `${dir}/node-git-server.gitauthenticateoptions.headers`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.gitauthenticateoptions.repo`, - }, - { - type: 'doc', - label: 'type', - id: `${dir}/node-git-server.gitauthenticateoptions.type`, - }, - { - type: 'doc', - label: 'user', - id: `${dir}/node-git-server.gitauthenticateoptions.user`, - }, - ], - }, - { - type: 'category', - label: 'GitEvents', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.gitevents`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/node-git-server.gitevents.on`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/node-git-server.gitevents.on_1`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/node-git-server.gitevents.on_2`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/node-git-server.gitevents.on_3`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/node-git-server.gitevents.on_4`, - }, - ], - }, - { - type: 'category', - label: 'GitOptions', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.gitoptions`, - }, - { - type: 'doc', - label: 'authenticate', - id: `${dir}/node-git-server.gitoptions.authenticate`, - }, - { - type: 'doc', - label: 'autoCreate', - id: `${dir}/node-git-server.gitoptions.autocreate`, - }, - { - type: 'doc', - label: 'checkout', - id: `${dir}/node-git-server.gitoptions.checkout`, - }, - ], - }, - { - type: 'category', - label: 'HeadData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.headdata`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.headdata.repo`, - }, - ], - }, - { - type: 'category', - label: 'HttpDuplex', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.httpduplex`, - }, - { - type: 'doc', - label: '(constructor)', - id: `${dir}/node-git-server.httpduplex._constructor_`, - }, - { - type: 'doc', - label: 'accept', - id: `${dir}/node-git-server.httpduplex.accept`, - }, - { - type: 'doc', - label: 'complete', - id: `${dir}/node-git-server.httpduplex.complete`, - }, - { - type: 'doc', - label: 'connection', - id: `${dir}/node-git-server.httpduplex.connection`, - }, - { - type: 'doc', - label: 'cork', - id: `${dir}/node-git-server.httpduplex.cork`, - }, - { - type: 'doc', - label: 'cwd', - id: `${dir}/node-git-server.httpduplex.cwd`, - }, - { - type: 'doc', - label: 'destroy', - id: `${dir}/node-git-server.httpduplex.destroy`, - }, - { - type: 'doc', - label: 'end', - id: `${dir}/node-git-server.httpduplex.end`, - }, - { - type: 'doc', - label: 'exists', - id: `${dir}/node-git-server.httpduplex.exists`, - }, - { - type: 'doc', - label: 'headers', - id: `${dir}/node-git-server.httpduplex.headers`, - }, - { - type: 'doc', - label: 'httpVersion', - id: `${dir}/node-git-server.httpduplex.httpversion`, - }, - { - type: 'doc', - label: 'httpVersionMajor', - id: `${dir}/node-git-server.httpduplex.httpversionmajor`, - }, - { - type: 'doc', - label: 'httpVersionMinor', - id: `${dir}/node-git-server.httpduplex.httpversionminor`, - }, - { - type: 'doc', - label: 'method', - id: `${dir}/node-git-server.httpduplex.method`, - }, - { - type: 'doc', - label: 'readable', - id: `${dir}/node-git-server.httpduplex.readable`, - }, - { - type: 'doc', - label: 'reject', - id: `${dir}/node-git-server.httpduplex.reject`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.httpduplex.repo`, - }, - { - type: 'doc', - label: 'req', - id: `${dir}/node-git-server.httpduplex.req`, - }, - { - type: 'doc', - label: 'res', - id: `${dir}/node-git-server.httpduplex.res`, - }, - { - type: 'doc', - label: 'setHeader', - id: `${dir}/node-git-server.httpduplex.setheader`, - }, - { - type: 'doc', - label: 'socket', - id: `${dir}/node-git-server.httpduplex.socket`, - }, - { - type: 'doc', - label: 'statusCode', - id: `${dir}/node-git-server.httpduplex.statuscode`, - }, - { - type: 'doc', - label: 'statusMessage', - id: `${dir}/node-git-server.httpduplex.statusmessage`, - }, - { - type: 'doc', - label: 'trailers', - id: `${dir}/node-git-server.httpduplex.trailers`, - }, - { - type: 'doc', - label: 'uncork', - id: `${dir}/node-git-server.httpduplex.uncork`, - }, - { - type: 'doc', - label: 'url', - id: `${dir}/node-git-server.httpduplex.url`, - }, - { - type: 'doc', - label: 'writable', - id: `${dir}/node-git-server.httpduplex.writable`, - }, - { - type: 'doc', - label: 'writeHead', - id: `${dir}/node-git-server.httpduplex.writehead`, - }, - ], - }, - { - type: 'category', - label: 'InfoData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.infodata`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.infodata.repo`, - }, - ], - }, - { - type: 'doc', - label: 'infoResponse', - id: `${dir}/node-git-server.inforesponse`, - }, - { - type: 'doc', - label: 'noCache', - id: `${dir}/node-git-server.nocache`, - }, - { - type: 'doc', - label: 'packSideband', - id: `${dir}/node-git-server.packsideband`, - }, - { - type: 'doc', - label: 'parseGitName', - id: `${dir}/node-git-server.parsegitname`, - }, - { - type: 'category', - label: 'PushData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.pushdata`, - }, - { - type: 'doc', - label: 'branch', - id: `${dir}/node-git-server.pushdata.branch`, - }, - { - type: 'doc', - label: 'commit', - id: `${dir}/node-git-server.pushdata.commit`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.pushdata.repo`, - }, - ], - }, - { - type: 'category', - label: 'Service', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.service`, - }, - { - type: 'doc', - label: '(constructor)', - id: `${dir}/node-git-server.service._constructor_`, - }, - { - type: 'doc', - label: 'accept', - id: `${dir}/node-git-server.service.accept`, - }, - { - type: 'doc', - label: 'commit', - id: `${dir}/node-git-server.service.commit`, - }, - { - type: 'doc', - label: 'cwd', - id: `${dir}/node-git-server.service.cwd`, - }, - { - type: 'doc', - label: 'evName', - id: `${dir}/node-git-server.service.evname`, - }, - { - type: 'doc', - label: 'last', - id: `${dir}/node-git-server.service.last`, - }, - { - type: 'doc', - label: 'log', - id: `${dir}/node-git-server.service.log`, - }, - { - type: 'doc', - label: 'logs', - id: `${dir}/node-git-server.service.logs`, - }, - { - type: 'doc', - label: 'reject', - id: `${dir}/node-git-server.service.reject`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.service.repo`, - }, - { - type: 'doc', - label: 'service', - id: `${dir}/node-git-server.service.service`, - }, - { - type: 'doc', - label: 'status', - id: `${dir}/node-git-server.service.status`, - }, - { - type: 'doc', - label: 'username', - id: `${dir}/node-git-server.service.username`, - }, - ], - }, - { - type: 'category', - label: 'ServiceOptions', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.serviceoptions`, - }, - { - type: 'doc', - label: 'cwd', - id: `${dir}/node-git-server.serviceoptions.cwd`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.serviceoptions.repo`, - }, - { - type: 'doc', - label: 'service', - id: `${dir}/node-git-server.serviceoptions.service`, - }, - ], - }, - { - type: 'doc', - label: 'serviceRespond', - id: `${dir}/node-git-server.servicerespond`, - }, - { - type: 'doc', - label: 'ServiceString', - id: `${dir}/node-git-server.servicestring`, - }, - { - type: 'category', - label: 'TagData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/node-git-server.tagdata`, - }, - { - type: 'doc', - label: 'commit', - id: `${dir}/node-git-server.tagdata.commit`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/node-git-server.tagdata.repo`, - }, - { - type: 'doc', - label: 'version', - id: `${dir}/node-git-server.tagdata.version`, - }, - ], - }, - ], - }, - { - type: 'category', - label: 'website', - collapsed: false, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website`, - }, - { - type: 'doc', - label: 'basicAuth', - id: `${dir}/website.basicauth`, - }, - { - type: 'doc', - label: 'createAction', - id: `${dir}/website.createaction`, - }, - { - type: 'category', - label: 'FetchData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.fetchdata`, - }, - { - type: 'doc', - label: 'commit', - id: `${dir}/website.fetchdata.commit`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.fetchdata.repo`, - }, - ], - }, - { - type: 'category', - label: 'Git', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.git`, - }, - { - type: 'doc', - label: '(constructor)', - id: `${dir}/website.git._constructor_`, - }, - { - type: 'doc', - label: 'authenticate', - id: `${dir}/website.git.authenticate`, - }, - { - type: 'doc', - label: 'autoCreate', - id: `${dir}/website.git.autocreate`, - }, - { - type: 'doc', - label: 'checkout', - id: `${dir}/website.git.checkout`, - }, - { - type: 'doc', - label: 'close', - id: `${dir}/website.git.close`, - }, - { - type: 'doc', - label: 'create', - id: `${dir}/website.git.create`, - }, - { - type: 'doc', - label: 'dirMap', - id: `${dir}/website.git.dirmap`, - }, - { - type: 'doc', - label: 'exists', - id: `${dir}/website.git.exists`, - }, - { - type: 'doc', - label: 'getType', - id: `${dir}/website.git.gettype`, - }, - { - type: 'doc', - label: 'handle', - id: `${dir}/website.git.handle`, - }, - { - type: 'doc', - label: 'list', - id: `${dir}/website.git.list`, - }, - { - type: 'doc', - label: 'list', - id: `${dir}/website.git.list_1`, - }, - { - type: 'doc', - label: 'listen', - id: `${dir}/website.git.listen`, - }, - { - type: 'doc', - label: 'mkdir', - id: `${dir}/website.git.mkdir`, - }, - { - type: 'doc', - label: 'server', - id: `${dir}/website.git.server`, - }, - ], - }, - { - type: 'category', - label: 'GitAuthenticateOptions', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.gitauthenticateoptions`, - }, - { - type: 'doc', - label: 'headers', - id: `${dir}/website.gitauthenticateoptions.headers`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.gitauthenticateoptions.repo`, - }, - { - type: 'doc', - label: 'type', - id: `${dir}/website.gitauthenticateoptions.type`, - }, - { - type: 'doc', - label: 'user', - id: `${dir}/website.gitauthenticateoptions.user`, - }, - ], - }, - { - type: 'category', - label: 'GitEvents', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.gitevents`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/website.gitevents.on`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/website.gitevents.on_1`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/website.gitevents.on_2`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/website.gitevents.on_3`, - }, - { - type: 'doc', - label: 'on', - id: `${dir}/website.gitevents.on_4`, - }, - ], - }, - { - type: 'category', - label: 'GitOptions', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.gitoptions`, - }, - { - type: 'doc', - label: 'authenticate', - id: `${dir}/website.gitoptions.authenticate`, - }, - { - type: 'doc', - label: 'autoCreate', - id: `${dir}/website.gitoptions.autocreate`, - }, - { - type: 'doc', - label: 'checkout', - id: `${dir}/website.gitoptions.checkout`, - }, - ], - }, - { - type: 'category', - label: 'HeadData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.headdata`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.headdata.repo`, - }, - ], - }, - { - type: 'category', - label: 'HttpDuplex', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.httpduplex`, - }, - { - type: 'doc', - label: '(constructor)', - id: `${dir}/website.httpduplex._constructor_`, - }, - { - type: 'doc', - label: 'accept', - id: `${dir}/website.httpduplex.accept`, - }, - { - type: 'doc', - label: 'complete', - id: `${dir}/website.httpduplex.complete`, - }, - { - type: 'doc', - label: 'connection', - id: `${dir}/website.httpduplex.connection`, - }, - { - type: 'doc', - label: 'cork', - id: `${dir}/website.httpduplex.cork`, - }, - { - type: 'doc', - label: 'cwd', - id: `${dir}/website.httpduplex.cwd`, - }, - { - type: 'doc', - label: 'destroy', - id: `${dir}/website.httpduplex.destroy`, - }, - { - type: 'doc', - label: 'end', - id: `${dir}/website.httpduplex.end`, - }, - { - type: 'doc', - label: 'exists', - id: `${dir}/website.httpduplex.exists`, - }, - { - type: 'doc', - label: 'headers', - id: `${dir}/website.httpduplex.headers`, - }, - { - type: 'doc', - label: 'httpVersion', - id: `${dir}/website.httpduplex.httpversion`, - }, - { - type: 'doc', - label: 'httpVersionMajor', - id: `${dir}/website.httpduplex.httpversionmajor`, - }, - { - type: 'doc', - label: 'httpVersionMinor', - id: `${dir}/website.httpduplex.httpversionminor`, - }, - { - type: 'doc', - label: 'method', - id: `${dir}/website.httpduplex.method`, - }, - { - type: 'doc', - label: 'readable', - id: `${dir}/website.httpduplex.readable`, - }, - { - type: 'doc', - label: 'reject', - id: `${dir}/website.httpduplex.reject`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.httpduplex.repo`, - }, - { - type: 'doc', - label: 'req', - id: `${dir}/website.httpduplex.req`, - }, - { - type: 'doc', - label: 'res', - id: `${dir}/website.httpduplex.res`, - }, - { - type: 'doc', - label: 'setHeader', - id: `${dir}/website.httpduplex.setheader`, - }, - { - type: 'doc', - label: 'socket', - id: `${dir}/website.httpduplex.socket`, - }, - { - type: 'doc', - label: 'statusCode', - id: `${dir}/website.httpduplex.statuscode`, - }, - { - type: 'doc', - label: 'statusMessage', - id: `${dir}/website.httpduplex.statusmessage`, - }, - { - type: 'doc', - label: 'trailers', - id: `${dir}/website.httpduplex.trailers`, - }, - { - type: 'doc', - label: 'uncork', - id: `${dir}/website.httpduplex.uncork`, - }, - { - type: 'doc', - label: 'url', - id: `${dir}/website.httpduplex.url`, - }, - { - type: 'doc', - label: 'writable', - id: `${dir}/website.httpduplex.writable`, - }, - { - type: 'doc', - label: 'writeHead', - id: `${dir}/website.httpduplex.writehead`, - }, - ], - }, - { - type: 'category', - label: 'InfoData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.infodata`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.infodata.repo`, - }, - ], - }, - { - type: 'doc', - label: 'infoResponse', - id: `${dir}/website.inforesponse`, - }, - { - type: 'doc', - label: 'noCache', - id: `${dir}/website.nocache`, - }, - { - type: 'doc', - label: 'packSideband', - id: `${dir}/website.packsideband`, - }, - { - type: 'doc', - label: 'parseGitName', - id: `${dir}/website.parsegitname`, - }, - { - type: 'category', - label: 'PushData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.pushdata`, - }, - { - type: 'doc', - label: 'branch', - id: `${dir}/website.pushdata.branch`, - }, - { - type: 'doc', - label: 'commit', - id: `${dir}/website.pushdata.commit`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.pushdata.repo`, - }, - ], - }, - { - type: 'category', - label: 'Service', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.service`, - }, - { - type: 'doc', - label: '(constructor)', - id: `${dir}/website.service._constructor_`, - }, - { - type: 'doc', - label: 'accept', - id: `${dir}/website.service.accept`, - }, - { - type: 'doc', - label: 'commit', - id: `${dir}/website.service.commit`, - }, - { - type: 'doc', - label: 'cwd', - id: `${dir}/website.service.cwd`, - }, - { - type: 'doc', - label: 'evName', - id: `${dir}/website.service.evname`, - }, - { - type: 'doc', - label: 'last', - id: `${dir}/website.service.last`, - }, - { - type: 'doc', - label: 'log', - id: `${dir}/website.service.log`, - }, - { - type: 'doc', - label: 'logs', - id: `${dir}/website.service.logs`, - }, - { - type: 'doc', - label: 'reject', - id: `${dir}/website.service.reject`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.service.repo`, - }, - { - type: 'doc', - label: 'service', - id: `${dir}/website.service.service`, - }, - { - type: 'doc', - label: 'status', - id: `${dir}/website.service.status`, - }, - { - type: 'doc', - label: 'username', - id: `${dir}/website.service.username`, - }, - ], - }, - { - type: 'category', - label: 'ServiceOptions', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.serviceoptions`, - }, - { - type: 'doc', - label: 'cwd', - id: `${dir}/website.serviceoptions.cwd`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.serviceoptions.repo`, - }, - { - type: 'doc', - label: 'service', - id: `${dir}/website.serviceoptions.service`, - }, - ], - }, - { - type: 'doc', - label: 'serviceRespond', - id: `${dir}/website.servicerespond`, - }, - { - type: 'doc', - label: 'ServiceString', - id: `${dir}/website.servicestring`, - }, - { - type: 'category', - label: 'TagData', - collapsed: true, - items: [ - { - type: 'doc', - label: 'Overview', - id: `${dir}/website.tagdata`, - }, - { - type: 'doc', - label: 'commit', - id: `${dir}/website.tagdata.commit`, - }, - { - type: 'doc', - label: 'repo', - id: `${dir}/website.tagdata.repo`, - }, - { - type: 'doc', - label: 'version', - id: `${dir}/website.tagdata.version`, - }, - ], - }, - ], - }, - ], - }, -]; diff --git a/website/docs/api/index.md b/website/docs/api/index.md deleted file mode 100644 index df0db1f..0000000 --- a/website/docs/api/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: index -hide_title: true -custom_edit_url: null -title: API Reference -slug: / ---- - - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --------------------------------------- | ----------- | -| [node-git-server](./node-git-server.md) | | diff --git a/website/docs/api/node-git-server.basicauth.md b/website/docs/api/node-git-server.basicauth.md deleted file mode 100644 index fd9e626..0000000 --- a/website/docs/api/node-git-server.basicauth.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: node-git-server.basicauth -hide_title: true -custom_edit_url: null -title: basicAuth() function ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [basicAuth](./node-git-server.basicauth.md) - -## basicAuth() function - -sets and parses basic auth headers if they exist - -Signature: - -```typescript -export declare function basicAuth(req: http.IncomingMessage, res: http.ServerResponse, callback: (username?: string, password?: string) => void): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| req | http.IncomingMessage | http request object | -| res | http.ServerResponse | http response | -| callback | (username?: string, password?: string) => void | function(username, password) | - -Returns: - -void diff --git a/website/docs/api/node-git-server.createaction.md b/website/docs/api/node-git-server.createaction.md deleted file mode 100644 index 61b96a4..0000000 --- a/website/docs/api/node-git-server.createaction.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: node-git-server.createaction -hide_title: true -custom_edit_url: null -title: createAction() function ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [createAction](./node-git-server.createaction.md) - -## createAction() function - -responds with the correct service depending on the action - -Signature: - -```typescript -export declare function createAction(opts: ServiceOptions, req: http.IncomingMessage, res: http.ServerResponse): Service; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| opts | [ServiceOptions](./node-git-server.serviceoptions.md) | options to pass Service | -| req | http.IncomingMessage | http request object | -| res | http.ServerResponse | http response | - -Returns: - -[Service](./node-git-server.service.md) diff --git a/website/docs/api/node-git-server.fetchdata.commit.md b/website/docs/api/node-git-server.fetchdata.commit.md deleted file mode 100644 index 1209bfc..0000000 --- a/website/docs/api/node-git-server.fetchdata.commit.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.fetchdata.commit -hide_title: true -custom_edit_url: null -title: FetchData.commit property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [FetchData](./node-git-server.fetchdata.md) > [commit](./node-git-server.fetchdata.commit.md) - -## FetchData.commit property - -Signature: - -```typescript -commit: string; -``` diff --git a/website/docs/api/node-git-server.fetchdata.md b/website/docs/api/node-git-server.fetchdata.md deleted file mode 100644 index 0ed3664..0000000 --- a/website/docs/api/node-git-server.fetchdata.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: node-git-server.fetchdata -hide_title: true -custom_edit_url: null -title: FetchData interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [FetchData](./node-git-server.fetchdata.md) - -## FetchData interface - -an http duplex object (see below) with these extra properties - -Signature: - -```typescript -export interface FetchData extends HttpDuplex -``` - -**Extends:** [HttpDuplex](./node-git-server.httpduplex.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [commit](./node-git-server.fetchdata.commit.md) | string | | -| [repo](./node-git-server.fetchdata.repo.md) | string | | diff --git a/website/docs/api/node-git-server.fetchdata.repo.md b/website/docs/api/node-git-server.fetchdata.repo.md deleted file mode 100644 index be352ec..0000000 --- a/website/docs/api/node-git-server.fetchdata.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.fetchdata.repo -hide_title: true -custom_edit_url: null -title: FetchData.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [FetchData](./node-git-server.fetchdata.md) > [repo](./node-git-server.fetchdata.repo.md) - -## FetchData.repo property - -Signature: - -```typescript -repo: string; -``` diff --git a/website/docs/api/node-git-server.git._constructor_.md b/website/docs/api/node-git-server.git._constructor_.md deleted file mode 100644 index 50e764d..0000000 --- a/website/docs/api/node-git-server.git._constructor_.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: node-git-server.git._constructor_ -hide_title: true -custom_edit_url: null -title: Git.(constructor) ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [(constructor)](./node-git-server.git._constructor_.md) - -## Git.(constructor) - -Handles invoking the git-\*-pack binaries - -Signature: - -```typescript -constructor(repoDir: string | ((dir?: string) => string), options?: GitOptions); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| repoDir | string | ((dir?: string) => string) | Create a new repository collection from the directory repoDir. repoDir should be entirely empty except for git repo directories. If repoDir is a function, repoDir(repo) will be used to dynamically resolve project directories. The return value of repoDir(repo) should be a string path specifying where to put the string repo. Make sure to return the same value for repo every time since repoDir(repo) will be called multiple times. | -| options | [GitOptions](./node-git-server.gitoptions.md) | options that can be applied on the new instance being created | diff --git a/website/docs/api/node-git-server.git.authenticate.md b/website/docs/api/node-git-server.git.authenticate.md deleted file mode 100644 index 32be69b..0000000 --- a/website/docs/api/node-git-server.git.authenticate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.git.authenticate -hide_title: true -custom_edit_url: null -title: Git.authenticate property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [authenticate](./node-git-server.git.authenticate.md) - -## Git.authenticate property - -Signature: - -```typescript -authenticate: ((options: GitAuthenticateOptions, callback: (error?: Error) => void | undefined) => void | Promise | undefined) | undefined; -``` diff --git a/website/docs/api/node-git-server.git.autocreate.md b/website/docs/api/node-git-server.git.autocreate.md deleted file mode 100644 index e79431f..0000000 --- a/website/docs/api/node-git-server.git.autocreate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.git.autocreate -hide_title: true -custom_edit_url: null -title: Git.autoCreate property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [autoCreate](./node-git-server.git.autocreate.md) - -## Git.autoCreate property - -Signature: - -```typescript -autoCreate: boolean; -``` diff --git a/website/docs/api/node-git-server.git.checkout.md b/website/docs/api/node-git-server.git.checkout.md deleted file mode 100644 index 37225be..0000000 --- a/website/docs/api/node-git-server.git.checkout.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.git.checkout -hide_title: true -custom_edit_url: null -title: Git.checkout property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [checkout](./node-git-server.git.checkout.md) - -## Git.checkout property - -Signature: - -```typescript -checkout: boolean | undefined; -``` diff --git a/website/docs/api/node-git-server.git.close.md b/website/docs/api/node-git-server.git.close.md deleted file mode 100644 index 66b31d1..0000000 --- a/website/docs/api/node-git-server.git.close.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: node-git-server.git.close -hide_title: true -custom_edit_url: null -title: Git.close() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [close](./node-git-server.git.close.md) - -## Git.close() method - -closes the server instance - -Signature: - -```typescript -close(): Promise; -``` - -Returns: - -Promise<string> diff --git a/website/docs/api/node-git-server.git.create.md b/website/docs/api/node-git-server.git.create.md deleted file mode 100644 index f3b1ede..0000000 --- a/website/docs/api/node-git-server.git.create.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -id: node-git-server.git.create -hide_title: true -custom_edit_url: null -title: Git.create() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [create](./node-git-server.git.create.md) - -## Git.create() method - -Create a new bare repository `repoName` in the instance repository directory. - -Signature: - -```typescript -create(repo: string, callback: (error?: Error) => void): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| repo | string | the name of the repo | -| callback | (error?: Error) => void | Optionally get a callback cb(err) to be notified when the repository was created. | - -Returns: - -void diff --git a/website/docs/api/node-git-server.git.dirmap.md b/website/docs/api/node-git-server.git.dirmap.md deleted file mode 100644 index cd3c292..0000000 --- a/website/docs/api/node-git-server.git.dirmap.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.git.dirmap -hide_title: true -custom_edit_url: null -title: Git.dirMap property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [dirMap](./node-git-server.git.dirmap.md) - -## Git.dirMap property - -Signature: - -```typescript -dirMap: (dir?: string) => string; -``` diff --git a/website/docs/api/node-git-server.git.exists.md b/website/docs/api/node-git-server.git.exists.md deleted file mode 100644 index 74596eb..0000000 --- a/website/docs/api/node-git-server.git.exists.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: node-git-server.git.exists -hide_title: true -custom_edit_url: null -title: Git.exists() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [exists](./node-git-server.git.exists.md) - -## Git.exists() method - -Find out whether `repoName` exists in the callback `cb(exists)`. - -Signature: - -```typescript -exists(repo: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| repo | string | name of the repo | - -Returns: - -boolean diff --git a/website/docs/api/node-git-server.git.gettype.md b/website/docs/api/node-git-server.git.gettype.md deleted file mode 100644 index ce5355f..0000000 --- a/website/docs/api/node-git-server.git.gettype.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: node-git-server.git.gettype -hide_title: true -custom_edit_url: null -title: Git.getType() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [getType](./node-git-server.git.gettype.md) - -## Git.getType() method - -returns the typeof service being process. This will respond with either fetch or push. - -Signature: - -```typescript -getType(service: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| service | string | the service type | - -Returns: - -string diff --git a/website/docs/api/node-git-server.git.handle.md b/website/docs/api/node-git-server.git.handle.md deleted file mode 100644 index dfaa782..0000000 --- a/website/docs/api/node-git-server.git.handle.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -id: node-git-server.git.handle -hide_title: true -custom_edit_url: null -title: Git.handle() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [handle](./node-git-server.git.handle.md) - -## Git.handle() method - -Handle incoming HTTP requests with a connect-style middleware - -Signature: - -```typescript -handle(req: http.IncomingMessage, res: http.ServerResponse): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| req | http.IncomingMessage | | -| res | http.ServerResponse | | - -Returns: - -void diff --git a/website/docs/api/node-git-server.git.list.md b/website/docs/api/node-git-server.git.list.md deleted file mode 100644 index 723d3d6..0000000 --- a/website/docs/api/node-git-server.git.list.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: node-git-server.git.list -hide_title: true -custom_edit_url: null -title: Git.list() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [list](./node-git-server.git.list.md) - -## Git.list() method - -Get a list of all the repositories - -Signature: - -```typescript -list(callback: (error: Error | undefined, repos?: string[]) => void): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| callback | (error: Error | undefined, repos?: string\[]) => void | function to be called when repositories have been found function(error, repos) | - -Returns: - -void diff --git a/website/docs/api/node-git-server.git.list_1.md b/website/docs/api/node-git-server.git.list_1.md deleted file mode 100644 index ef6c74a..0000000 --- a/website/docs/api/node-git-server.git.list_1.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: node-git-server.git.list_1 -hide_title: true -custom_edit_url: null -title: Git.list() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [list](./node-git-server.git.list_1.md) - -## Git.list() method - -Signature: - -```typescript -list(): Promise; -``` - -Returns: - -Promise<string\[]> diff --git a/website/docs/api/node-git-server.git.listen.md b/website/docs/api/node-git-server.git.listen.md deleted file mode 100644 index 7c4c97e..0000000 --- a/website/docs/api/node-git-server.git.listen.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: node-git-server.git.listen -hide_title: true -custom_edit_url: null -title: Git.listen() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [listen](./node-git-server.git.listen.md) - -## Git.listen() method - -starts a git server on the given port - -Signature: - -```typescript -listen(port: number, options?: GitServerOptions, callback?: () => void): Git; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | the port to start the server on | -| options | GitServerOptions | the options to add extended functionality to the server | -| callback | () => void | the function to call when server is started or error has occurred | - -Returns: - -[Git](./node-git-server.git.md) diff --git a/website/docs/api/node-git-server.git.md b/website/docs/api/node-git-server.git.md deleted file mode 100644 index 5ad6601..0000000 --- a/website/docs/api/node-git-server.git.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -id: node-git-server.git -hide_title: true -custom_edit_url: null -title: Git class ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) - -## Git class - -Signature: - -```typescript -export declare class Git extends EventEmitter implements GitEvents -``` - -**Extends:** EventEmitter - -**Implements:** [GitEvents](./node-git-server.gitevents.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(repoDir, options)](./node-git-server.git._constructor_.md) | | Handles invoking the git-\*-pack binaries | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [authenticate](./node-git-server.git.authenticate.md) | | ((options: [GitAuthenticateOptions](./node-git-server.gitauthenticateoptions.md), callback: (error?: Error) => void | undefined) => void | Promise\ | undefined) | undefined | | -| [autoCreate](./node-git-server.git.autocreate.md) | | boolean | | -| [checkout](./node-git-server.git.checkout.md) | | boolean | undefined | | -| [dirMap](./node-git-server.git.dirmap.md) | | (dir?: string) => string | | -| [server](./node-git-server.git.server.md) | | https.Server | http.Server | undefined | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [close()](./node-git-server.git.close.md) | | closes the server instance | -| [create(repo, callback)](./node-git-server.git.create.md) | | Create a new bare repository repoName in the instance repository directory. | -| [exists(repo)](./node-git-server.git.exists.md) | | Find out whether repoName exists in the callback cb(exists). | -| [getType(service)](./node-git-server.git.gettype.md) | | returns the typeof service being process. This will respond with either fetch or push. | -| [handle(req, res)](./node-git-server.git.handle.md) | | Handle incoming HTTP requests with a connect-style middleware | -| [list(callback)](./node-git-server.git.list.md) | | Get a list of all the repositories | -| [list()](./node-git-server.git.list_1.md) | | | -| [listen(port, options, callback)](./node-git-server.git.listen.md) | | starts a git server on the given port | -| [mkdir(dir)](./node-git-server.git.mkdir.md) | | Create a subdirectory dir in the repo dir with a callback. | diff --git a/website/docs/api/node-git-server.git.mkdir.md b/website/docs/api/node-git-server.git.mkdir.md deleted file mode 100644 index 93112e3..0000000 --- a/website/docs/api/node-git-server.git.mkdir.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: node-git-server.git.mkdir -hide_title: true -custom_edit_url: null -title: Git.mkdir() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [mkdir](./node-git-server.git.mkdir.md) - -## Git.mkdir() method - -Create a subdirectory `dir` in the repo dir with a callback. - -Signature: - -```typescript -mkdir(dir: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| dir | string | directory name | - -Returns: - -void diff --git a/website/docs/api/node-git-server.git.server.md b/website/docs/api/node-git-server.git.server.md deleted file mode 100644 index 44a8958..0000000 --- a/website/docs/api/node-git-server.git.server.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.git.server -hide_title: true -custom_edit_url: null -title: Git.server property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Git](./node-git-server.git.md) > [server](./node-git-server.git.server.md) - -## Git.server property - -Signature: - -```typescript -server: https.Server | http.Server | undefined; -``` diff --git a/website/docs/api/node-git-server.gitauthenticateoptions.headers.md b/website/docs/api/node-git-server.gitauthenticateoptions.headers.md deleted file mode 100644 index bfdbb9c..0000000 --- a/website/docs/api/node-git-server.gitauthenticateoptions.headers.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.gitauthenticateoptions.headers -hide_title: true -custom_edit_url: null -title: GitAuthenticateOptions.headers property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitAuthenticateOptions](./node-git-server.gitauthenticateoptions.md) > [headers](./node-git-server.gitauthenticateoptions.headers.md) - -## GitAuthenticateOptions.headers property - -Signature: - -```typescript -headers: http.IncomingHttpHeaders; -``` diff --git a/website/docs/api/node-git-server.gitauthenticateoptions.md b/website/docs/api/node-git-server.gitauthenticateoptions.md deleted file mode 100644 index 0255163..0000000 --- a/website/docs/api/node-git-server.gitauthenticateoptions.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: node-git-server.gitauthenticateoptions -hide_title: true -custom_edit_url: null -title: GitAuthenticateOptions interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitAuthenticateOptions](./node-git-server.gitauthenticateoptions.md) - -## GitAuthenticateOptions interface - -Signature: - -```typescript -export interface GitAuthenticateOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [headers](./node-git-server.gitauthenticateoptions.headers.md) | http.IncomingHttpHeaders | | -| [repo](./node-git-server.gitauthenticateoptions.repo.md) | string | | -| [type](./node-git-server.gitauthenticateoptions.type.md) | string | | -| [user](./node-git-server.gitauthenticateoptions.user.md) | (() => Promise<\[string | undefined, string | undefined]>) & ((callback: (username?: string | undefined, password?: string | undefined) => void) => void) | | diff --git a/website/docs/api/node-git-server.gitauthenticateoptions.repo.md b/website/docs/api/node-git-server.gitauthenticateoptions.repo.md deleted file mode 100644 index 90392ed..0000000 --- a/website/docs/api/node-git-server.gitauthenticateoptions.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.gitauthenticateoptions.repo -hide_title: true -custom_edit_url: null -title: GitAuthenticateOptions.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitAuthenticateOptions](./node-git-server.gitauthenticateoptions.md) > [repo](./node-git-server.gitauthenticateoptions.repo.md) - -## GitAuthenticateOptions.repo property - -Signature: - -```typescript -repo: string; -``` diff --git a/website/docs/api/node-git-server.gitauthenticateoptions.type.md b/website/docs/api/node-git-server.gitauthenticateoptions.type.md deleted file mode 100644 index 5641841..0000000 --- a/website/docs/api/node-git-server.gitauthenticateoptions.type.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.gitauthenticateoptions.type -hide_title: true -custom_edit_url: null -title: GitAuthenticateOptions.type property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitAuthenticateOptions](./node-git-server.gitauthenticateoptions.md) > [type](./node-git-server.gitauthenticateoptions.type.md) - -## GitAuthenticateOptions.type property - -Signature: - -```typescript -type: string; -``` diff --git a/website/docs/api/node-git-server.gitauthenticateoptions.user.md b/website/docs/api/node-git-server.gitauthenticateoptions.user.md deleted file mode 100644 index 36eadb9..0000000 --- a/website/docs/api/node-git-server.gitauthenticateoptions.user.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.gitauthenticateoptions.user -hide_title: true -custom_edit_url: null -title: GitAuthenticateOptions.user property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitAuthenticateOptions](./node-git-server.gitauthenticateoptions.md) > [user](./node-git-server.gitauthenticateoptions.user.md) - -## GitAuthenticateOptions.user property - -Signature: - -```typescript -user: (() => Promise<[string | undefined, string | undefined]>) & ((callback: (username?: string | undefined, password?: string | undefined) => void) => void); -``` diff --git a/website/docs/api/node-git-server.gitevents.md b/website/docs/api/node-git-server.gitevents.md deleted file mode 100644 index 07896cb..0000000 --- a/website/docs/api/node-git-server.gitevents.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: node-git-server.gitevents -hide_title: true -custom_edit_url: null -title: GitEvents interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitEvents](./node-git-server.gitevents.md) - -## GitEvents interface - -Signature: - -```typescript -export interface GitEvents -``` - -## Methods - -| Method | Description | -| --- | --- | -| [on(event, listener)](./node-git-server.gitevents.on.md) | | -| [on(event, listener)](./node-git-server.gitevents.on_1.md) | | -| [on(event, listener)](./node-git-server.gitevents.on_2.md) | | -| [on(event, listener)](./node-git-server.gitevents.on_3.md) | | -| [on(event, listener)](./node-git-server.gitevents.on_4.md) | | diff --git a/website/docs/api/node-git-server.gitevents.on.md b/website/docs/api/node-git-server.gitevents.on.md deleted file mode 100644 index 91afc56..0000000 --- a/website/docs/api/node-git-server.gitevents.on.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: node-git-server.gitevents.on -hide_title: true -custom_edit_url: null -title: GitEvents.on() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitEvents](./node-git-server.gitevents.md) > [on](./node-git-server.gitevents.on.md) - -## GitEvents.on() method - -Signature: - -```typescript -on(event: 'push', listener: (push: PushData) => void): this; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | 'push' | | -| listener | (push: [PushData](./node-git-server.pushdata.md)) => void | | - -Returns: - -this - -## Example - -repos.on('push', function (push) { ... } - -Emitted when somebody does a `git push` to the repo. - -Exactly one listener must call `push.accept()` or `push.reject()`. If there are no listeners, `push.accept()` is called automatically. diff --git a/website/docs/api/node-git-server.gitevents.on_1.md b/website/docs/api/node-git-server.gitevents.on_1.md deleted file mode 100644 index c562a9e..0000000 --- a/website/docs/api/node-git-server.gitevents.on_1.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: node-git-server.gitevents.on_1 -hide_title: true -custom_edit_url: null -title: GitEvents.on() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitEvents](./node-git-server.gitevents.md) > [on](./node-git-server.gitevents.on_1.md) - -## GitEvents.on() method - -Signature: - -```typescript -on(event: 'tag', listener: (tag: TagData) => void): this; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | 'tag' | | -| listener | (tag: [TagData](./node-git-server.tagdata.md)) => void | | - -Returns: - -this - -## Example - -repos.on('tag', function (tag) { ... } - -Emitted when somebody does a `git push --tags` to the repo. Exactly one listener must call `tag.accept()` or `tag.reject()`. If there are No listeners, `tag.accept()` is called automatically. diff --git a/website/docs/api/node-git-server.gitevents.on_2.md b/website/docs/api/node-git-server.gitevents.on_2.md deleted file mode 100644 index c1e6408..0000000 --- a/website/docs/api/node-git-server.gitevents.on_2.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: node-git-server.gitevents.on_2 -hide_title: true -custom_edit_url: null -title: GitEvents.on() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitEvents](./node-git-server.gitevents.md) > [on](./node-git-server.gitevents.on_2.md) - -## GitEvents.on() method - -Signature: - -```typescript -on(event: 'fetch', listener: (fetch: FetchData) => void): this; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | 'fetch' | | -| listener | (fetch: [FetchData](./node-git-server.fetchdata.md)) => void | | - -Returns: - -this - -## Example - -repos.on('fetch', function (fetch) { ... } - -Emitted when somebody does a `git fetch` to the repo (which happens whenever you do a `git pull` or a `git clone`). - -Exactly one listener must call `fetch.accept()` or `fetch.reject()`. If there are no listeners, `fetch.accept()` is called automatically. diff --git a/website/docs/api/node-git-server.gitevents.on_3.md b/website/docs/api/node-git-server.gitevents.on_3.md deleted file mode 100644 index 922d975..0000000 --- a/website/docs/api/node-git-server.gitevents.on_3.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: node-git-server.gitevents.on_3 -hide_title: true -custom_edit_url: null -title: GitEvents.on() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitEvents](./node-git-server.gitevents.md) > [on](./node-git-server.gitevents.on_3.md) - -## GitEvents.on() method - -Signature: - -```typescript -on(event: 'info', listener: (info: InfoData) => void): this; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | 'info' | | -| listener | (info: [InfoData](./node-git-server.infodata.md)) => void | | - -Returns: - -this - -## Example - -repos.on('info', function (info) { ... } - -Emitted when the repo is queried for info before doing other commands. - -Exactly one listener must call `info.accept()` or `info.reject()`. If there are no listeners, `info.accept()` is called automatically. diff --git a/website/docs/api/node-git-server.gitevents.on_4.md b/website/docs/api/node-git-server.gitevents.on_4.md deleted file mode 100644 index 77eef10..0000000 --- a/website/docs/api/node-git-server.gitevents.on_4.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: node-git-server.gitevents.on_4 -hide_title: true -custom_edit_url: null -title: GitEvents.on() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitEvents](./node-git-server.gitevents.md) > [on](./node-git-server.gitevents.on_4.md) - -## GitEvents.on() method - -Signature: - -```typescript -on(event: 'head', listener: (head: HeadData) => void): this; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | 'head' | | -| listener | (head: [HeadData](./node-git-server.headdata.md)) => void | | - -Returns: - -this - -## Example - -repos.on('head', function (head) { ... } - -Emitted when the repo is queried for HEAD before doing other commands. - -Exactly one listener must call `head.accept()` or `head.reject()`. If there are no listeners, `head.accept()` is called automatically. diff --git a/website/docs/api/node-git-server.gitoptions.authenticate.md b/website/docs/api/node-git-server.gitoptions.authenticate.md deleted file mode 100644 index ab8ce6b..0000000 --- a/website/docs/api/node-git-server.gitoptions.authenticate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.gitoptions.authenticate -hide_title: true -custom_edit_url: null -title: GitOptions.authenticate property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitOptions](./node-git-server.gitoptions.md) > [authenticate](./node-git-server.gitoptions.authenticate.md) - -## GitOptions.authenticate property - -Signature: - -```typescript -authenticate?: (options: GitAuthenticateOptions, callback: (error?: Error) => void | undefined) => void | Promise | undefined; -``` diff --git a/website/docs/api/node-git-server.gitoptions.autocreate.md b/website/docs/api/node-git-server.gitoptions.autocreate.md deleted file mode 100644 index 921b62d..0000000 --- a/website/docs/api/node-git-server.gitoptions.autocreate.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.gitoptions.autocreate -hide_title: true -custom_edit_url: null -title: GitOptions.autoCreate property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitOptions](./node-git-server.gitoptions.md) > [autoCreate](./node-git-server.gitoptions.autocreate.md) - -## GitOptions.autoCreate property - -Signature: - -```typescript -autoCreate?: boolean; -``` diff --git a/website/docs/api/node-git-server.gitoptions.checkout.md b/website/docs/api/node-git-server.gitoptions.checkout.md deleted file mode 100644 index 8f7f31a..0000000 --- a/website/docs/api/node-git-server.gitoptions.checkout.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.gitoptions.checkout -hide_title: true -custom_edit_url: null -title: GitOptions.checkout property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitOptions](./node-git-server.gitoptions.md) > [checkout](./node-git-server.gitoptions.checkout.md) - -## GitOptions.checkout property - -Signature: - -```typescript -checkout?: boolean; -``` diff --git a/website/docs/api/node-git-server.gitoptions.md b/website/docs/api/node-git-server.gitoptions.md deleted file mode 100644 index a52f539..0000000 --- a/website/docs/api/node-git-server.gitoptions.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: node-git-server.gitoptions -hide_title: true -custom_edit_url: null -title: GitOptions interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [GitOptions](./node-git-server.gitoptions.md) - -## GitOptions interface - -Signature: - -```typescript -export interface GitOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [authenticate?](./node-git-server.gitoptions.authenticate.md) | (options: [GitAuthenticateOptions](./node-git-server.gitauthenticateoptions.md), callback: (error?: Error) => void | undefined) => void | Promise\ | undefined | (Optional) | -| [autoCreate?](./node-git-server.gitoptions.autocreate.md) | boolean | (Optional) | -| [checkout?](./node-git-server.gitoptions.checkout.md) | boolean | (Optional) | diff --git a/website/docs/api/node-git-server.headdata.md b/website/docs/api/node-git-server.headdata.md deleted file mode 100644 index c0bea3d..0000000 --- a/website/docs/api/node-git-server.headdata.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: node-git-server.headdata -hide_title: true -custom_edit_url: null -title: HeadData interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HeadData](./node-git-server.headdata.md) - -## HeadData interface - -an http duplex object (see below) with these extra properties - -Signature: - -```typescript -export interface HeadData extends HttpDuplex -``` - -**Extends:** [HttpDuplex](./node-git-server.httpduplex.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [repo](./node-git-server.headdata.repo.md) | string | | diff --git a/website/docs/api/node-git-server.headdata.repo.md b/website/docs/api/node-git-server.headdata.repo.md deleted file mode 100644 index 66304f9..0000000 --- a/website/docs/api/node-git-server.headdata.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.headdata.repo -hide_title: true -custom_edit_url: null -title: HeadData.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HeadData](./node-git-server.headdata.md) > [repo](./node-git-server.headdata.repo.md) - -## HeadData.repo property - -Signature: - -```typescript -repo: string; -``` diff --git a/website/docs/api/node-git-server.httpduplex._constructor_.md b/website/docs/api/node-git-server.httpduplex._constructor_.md deleted file mode 100644 index 3f3c023..0000000 --- a/website/docs/api/node-git-server.httpduplex._constructor_.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: node-git-server.httpduplex._constructor_ -hide_title: true -custom_edit_url: null -title: HttpDuplex.(constructor) ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [(constructor)](./node-git-server.httpduplex._constructor_.md) - -## HttpDuplex.(constructor) - -Constructs a proxy object over input and output resulting in a unified stream. Generally meant to combine request and response streams in the http.request event - -Signature: - -```typescript -constructor(input: http.IncomingMessage, output: http.ServerResponse); -``` - -## Parameters - -| Parameter | Type | Description | -| --------- | -------------------- | ----------- | -| input | http.IncomingMessage | | -| output | http.ServerResponse | | - -## Example - - A simple example is shown below - -```js -http - .createServer(function (req, res) { - var dup = new HttpDuplex(req, res); - res.end('Request: ' + req.method + ' ' + req.url); - }) - .listen(80); -``` diff --git a/website/docs/api/node-git-server.httpduplex.accept.md b/website/docs/api/node-git-server.httpduplex.accept.md deleted file mode 100644 index 09641c4..0000000 --- a/website/docs/api/node-git-server.httpduplex.accept.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: node-git-server.httpduplex.accept -hide_title: true -custom_edit_url: null -title: HttpDuplex.accept() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [accept](./node-git-server.httpduplex.accept.md) - -## HttpDuplex.accept() method - -Signature: - -```typescript -accept(): void; -``` - -Returns: - -void diff --git a/website/docs/api/node-git-server.httpduplex.complete.md b/website/docs/api/node-git-server.httpduplex.complete.md deleted file mode 100644 index a12691d..0000000 --- a/website/docs/api/node-git-server.httpduplex.complete.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.httpduplex.complete -hide_title: true -custom_edit_url: null -title: HttpDuplex.complete property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [complete](./node-git-server.httpduplex.complete.md) - -## HttpDuplex.complete property - -Signature: - -```typescript -get complete(): boolean; -``` diff --git a/website/docs/api/node-git-server.httpduplex.connection.md b/website/docs/api/node-git-server.httpduplex.connection.md deleted file mode 100644 index e57ce87..0000000 --- a/website/docs/api/node-git-server.httpduplex.connection.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.connection -hide_title: true -custom_edit_url: null -title: HttpDuplex.connection property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [connection](./node-git-server.httpduplex.connection.md) - -## HttpDuplex.connection property - -Reference to the underlying socket for the request connection. - -Signature: - -```typescript -get connection(): import("net").Socket; -``` diff --git a/website/docs/api/node-git-server.httpduplex.cork.md b/website/docs/api/node-git-server.httpduplex.cork.md deleted file mode 100644 index 5f42720..0000000 --- a/website/docs/api/node-git-server.httpduplex.cork.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: node-git-server.httpduplex.cork -hide_title: true -custom_edit_url: null -title: HttpDuplex.cork() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [cork](./node-git-server.httpduplex.cork.md) - -## HttpDuplex.cork() method - -Buffers written data in memory. This data will be flushed when either the uncork or end methods are called. - -Signature: - -```typescript -cork(): this; -``` - -Returns: - -this - -## Example - -request.cork(); request.write('buffer data '); request.write('before sending '); request.uncork(); diff --git a/website/docs/api/node-git-server.httpduplex.cwd.md b/website/docs/api/node-git-server.httpduplex.cwd.md deleted file mode 100644 index d509a21..0000000 --- a/website/docs/api/node-git-server.httpduplex.cwd.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.httpduplex.cwd -hide_title: true -custom_edit_url: null -title: HttpDuplex.cwd property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [cwd](./node-git-server.httpduplex.cwd.md) - -## HttpDuplex.cwd property - -Signature: - -```typescript -cwd: string | undefined; -``` diff --git a/website/docs/api/node-git-server.httpduplex.destroy.md b/website/docs/api/node-git-server.httpduplex.destroy.md deleted file mode 100644 index fb9e283..0000000 --- a/website/docs/api/node-git-server.httpduplex.destroy.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: node-git-server.httpduplex.destroy -hide_title: true -custom_edit_url: null -title: HttpDuplex.destroy() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [destroy](./node-git-server.httpduplex.destroy.md) - -## HttpDuplex.destroy() method - -Signature: - -```typescript -destroy(): void; -``` - -Returns: - -void diff --git a/website/docs/api/node-git-server.httpduplex.end.md b/website/docs/api/node-git-server.httpduplex.end.md deleted file mode 100644 index 033f318..0000000 --- a/website/docs/api/node-git-server.httpduplex.end.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: node-git-server.httpduplex.end -hide_title: true -custom_edit_url: null -title: HttpDuplex.end() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [end](./node-git-server.httpduplex.end.md) - -## HttpDuplex.end() method - -Signature: - -```typescript -end(reason?: any): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| reason | any | | - -Returns: - -void diff --git a/website/docs/api/node-git-server.httpduplex.exists.md b/website/docs/api/node-git-server.httpduplex.exists.md deleted file mode 100644 index 0ed0967..0000000 --- a/website/docs/api/node-git-server.httpduplex.exists.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.httpduplex.exists -hide_title: true -custom_edit_url: null -title: HttpDuplex.exists property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [exists](./node-git-server.httpduplex.exists.md) - -## HttpDuplex.exists property - -Signature: - -```typescript -exists: boolean | undefined; -``` diff --git a/website/docs/api/node-git-server.httpduplex.headers.md b/website/docs/api/node-git-server.httpduplex.headers.md deleted file mode 100644 index 8f53082..0000000 --- a/website/docs/api/node-git-server.httpduplex.headers.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.headers -hide_title: true -custom_edit_url: null -title: HttpDuplex.headers property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [headers](./node-git-server.httpduplex.headers.md) - -## HttpDuplex.headers property - -Request/response headers. Key-value pairs of header names and values. Header names are always lower-case. - -Signature: - -```typescript -get headers(): http.IncomingHttpHeaders; -``` diff --git a/website/docs/api/node-git-server.httpduplex.httpversion.md b/website/docs/api/node-git-server.httpduplex.httpversion.md deleted file mode 100644 index e8943bf..0000000 --- a/website/docs/api/node-git-server.httpduplex.httpversion.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.httpversion -hide_title: true -custom_edit_url: null -title: HttpDuplex.httpVersion property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [httpVersion](./node-git-server.httpduplex.httpversion.md) - -## HttpDuplex.httpVersion property - -Requested HTTP Version sent by the client. Usually either '1.0' or '1.1' - -Signature: - -```typescript -get httpVersion(): string; -``` diff --git a/website/docs/api/node-git-server.httpduplex.httpversionmajor.md b/website/docs/api/node-git-server.httpduplex.httpversionmajor.md deleted file mode 100644 index d1d0efb..0000000 --- a/website/docs/api/node-git-server.httpduplex.httpversionmajor.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.httpversionmajor -hide_title: true -custom_edit_url: null -title: HttpDuplex.httpVersionMajor property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [httpVersionMajor](./node-git-server.httpduplex.httpversionmajor.md) - -## HttpDuplex.httpVersionMajor property - -First integer in the httpVersion string - -Signature: - -```typescript -get httpVersionMajor(): number; -``` diff --git a/website/docs/api/node-git-server.httpduplex.httpversionminor.md b/website/docs/api/node-git-server.httpduplex.httpversionminor.md deleted file mode 100644 index 5e1a658..0000000 --- a/website/docs/api/node-git-server.httpduplex.httpversionminor.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.httpversionminor -hide_title: true -custom_edit_url: null -title: HttpDuplex.httpVersionMinor property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [httpVersionMinor](./node-git-server.httpduplex.httpversionminor.md) - -## HttpDuplex.httpVersionMinor property - -Second integer ni the httpVersion string - -Signature: - -```typescript -get httpVersionMinor(): number; -``` diff --git a/website/docs/api/node-git-server.httpduplex.md b/website/docs/api/node-git-server.httpduplex.md deleted file mode 100644 index df4d097..0000000 --- a/website/docs/api/node-git-server.httpduplex.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: node-git-server.httpduplex -hide_title: true -custom_edit_url: null -title: HttpDuplex class ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) - -## HttpDuplex class - -Signature: - -```typescript -export declare class HttpDuplex extends EventEmitter -``` - -**Extends:** EventEmitter - -## Constructors - -| Constructor | Modifiers | Description | -| ----------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [(constructor)(input, output)](./node-git-server.httpduplex._constructor_.md) | | Constructs a proxy object over input and output resulting in a unified stream. Generally meant to combine request and response streams in the http.request event | - -## Properties - -| Property | Modifiers | Type | Description | -| -------------------------------------------------------------------- | --------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- | -| [complete](./node-git-server.httpduplex.complete.md) | | boolean | | -| [connection](./node-git-server.httpduplex.connection.md) | | import("net").Socket | Reference to the underlying socket for the request connection. | -| [cwd](./node-git-server.httpduplex.cwd.md) | | string | undefined | | -| [exists](./node-git-server.httpduplex.exists.md) | | boolean | undefined | | -| [headers](./node-git-server.httpduplex.headers.md) | | http.IncomingHttpHeaders | Request/response headers. Key-value pairs of header names and values. Header names are always lower-case. | -| [httpVersion](./node-git-server.httpduplex.httpversion.md) | | string | Requested HTTP Version sent by the client. Usually either '1.0' or '1.1' | -| [httpVersionMajor](./node-git-server.httpduplex.httpversionmajor.md) | | number | First integer in the httpVersion string | -| [httpVersionMinor](./node-git-server.httpduplex.httpversionminor.md) | | number | Second integer ni the httpVersion string | -| [method](./node-git-server.httpduplex.method.md) | | string | undefined | Request method of the incoming request. | -| [readable](./node-git-server.httpduplex.readable.md) | | boolean | Is this stream readable. | -| [repo](./node-git-server.httpduplex.repo.md) | | string | undefined | | -| [req](./node-git-server.httpduplex.req.md) | | http.IncomingMessage | A IncomingMessage created by http.Server or http.ClientRequest usually passed as the first parameter to the 'request' and 'response' events. Implements Readable Stream interface but may not be a decendant thereof. | -| [res](./node-git-server.httpduplex.res.md) | | http.ServerResponse | Created http.server. Passed as the second parameter to the 'request' event. The response implements Writable Stream interface but isn't a descendent thereof. | -| [socket](./node-git-server.httpduplex.socket.md) | | import("net").Socket | net.Socket object associated with the connection. | -| [statusCode](./node-git-server.httpduplex.statuscode.md) | | number | The HTTP status code. Generally assigned before sending headers for a response to a client. | -| [statusMessage](./node-git-server.httpduplex.statusmessage.md) | | string | Controls the status message sent to the client as long as an explicit call to response.writeHead() isn't made If ignored or the value is undefined, the default message corresponding to the status code will be used. | -| [trailers](./node-git-server.httpduplex.trailers.md) | | NodeJS.Dict\ | Request/response trailer headers. Just like except these are only written after the initial response to the client. This object is only populated at the 'end' event and only work if a 'transfer-encoding: chunked' header is sent in the initial response. | -| [url](./node-git-server.httpduplex.url.md) | | string | undefined | Request URL string. | -| [writable](./node-git-server.httpduplex.writable.md) | | boolean | | - -## Methods - -| Method | Modifiers | Description | -| ------------------------------------------------------------------------------------------ | --------- | -------------------------------------------------------------------------------------------------------------- | -| [accept()](./node-git-server.httpduplex.accept.md) | | | -| [cork()](./node-git-server.httpduplex.cork.md) | | Buffers written data in memory. This data will be flushed when either the uncork or end methods are called. | -| [destroy()](./node-git-server.httpduplex.destroy.md) | | | -| [end(reason)](./node-git-server.httpduplex.end.md) | | | -| [reject(code, msg)](./node-git-server.httpduplex.reject.md) | | | -| [setHeader(arg0, arg1)](./node-git-server.httpduplex.setheader.md) | | | -| [uncork()](./node-git-server.httpduplex.uncork.md) | | Flushes all data buffered since cork() was called. | -| [writeHead(statusCode, statusMessage, headers)](./node-git-server.httpduplex.writehead.md) | | Sends a response header to the client request. Must only be called one time and before calling response.end(). | diff --git a/website/docs/api/node-git-server.httpduplex.method.md b/website/docs/api/node-git-server.httpduplex.method.md deleted file mode 100644 index 5a74658..0000000 --- a/website/docs/api/node-git-server.httpduplex.method.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: node-git-server.httpduplex.method -hide_title: true -custom_edit_url: null -title: HttpDuplex.method property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [method](./node-git-server.httpduplex.method.md) - -## HttpDuplex.method property - -Request method of the incoming request. - -Signature: - -```typescript -get method(): string | undefined; -``` - -## Example - -'GET', 'DELETE' diff --git a/website/docs/api/node-git-server.httpduplex.readable.md b/website/docs/api/node-git-server.httpduplex.readable.md deleted file mode 100644 index e11aedc..0000000 --- a/website/docs/api/node-git-server.httpduplex.readable.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.readable -hide_title: true -custom_edit_url: null -title: HttpDuplex.readable property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [readable](./node-git-server.httpduplex.readable.md) - -## HttpDuplex.readable property - -Is this stream readable. - -Signature: - -```typescript -get readable(): boolean; -``` diff --git a/website/docs/api/node-git-server.httpduplex.reject.md b/website/docs/api/node-git-server.httpduplex.reject.md deleted file mode 100644 index 366d732..0000000 --- a/website/docs/api/node-git-server.httpduplex.reject.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: node-git-server.httpduplex.reject -hide_title: true -custom_edit_url: null -title: HttpDuplex.reject() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [reject](./node-git-server.httpduplex.reject.md) - -## HttpDuplex.reject() method - -Signature: - -```typescript -reject(code: number, msg: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| code | number | | -| msg | string | | - -Returns: - -void diff --git a/website/docs/api/node-git-server.httpduplex.repo.md b/website/docs/api/node-git-server.httpduplex.repo.md deleted file mode 100644 index ef983df..0000000 --- a/website/docs/api/node-git-server.httpduplex.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.httpduplex.repo -hide_title: true -custom_edit_url: null -title: HttpDuplex.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [repo](./node-git-server.httpduplex.repo.md) - -## HttpDuplex.repo property - -Signature: - -```typescript -repo: string | undefined; -``` diff --git a/website/docs/api/node-git-server.httpduplex.req.md b/website/docs/api/node-git-server.httpduplex.req.md deleted file mode 100644 index a660ad2..0000000 --- a/website/docs/api/node-git-server.httpduplex.req.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.req -hide_title: true -custom_edit_url: null -title: HttpDuplex.req property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [req](./node-git-server.httpduplex.req.md) - -## HttpDuplex.req property - -A IncomingMessage created by http.Server or http.ClientRequest usually passed as the first parameter to the 'request' and 'response' events. Implements Readable Stream interface but may not be a decendant thereof. - -Signature: - -```typescript -req: http.IncomingMessage; -``` diff --git a/website/docs/api/node-git-server.httpduplex.res.md b/website/docs/api/node-git-server.httpduplex.res.md deleted file mode 100644 index 09e8b64..0000000 --- a/website/docs/api/node-git-server.httpduplex.res.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.res -hide_title: true -custom_edit_url: null -title: HttpDuplex.res property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [res](./node-git-server.httpduplex.res.md) - -## HttpDuplex.res property - -Created http.server. Passed as the second parameter to the 'request' event. The response implements Writable Stream interface but isn't a descendent thereof. - -Signature: - -```typescript -res: http.ServerResponse; -``` diff --git a/website/docs/api/node-git-server.httpduplex.setheader.md b/website/docs/api/node-git-server.httpduplex.setheader.md deleted file mode 100644 index e5fb14b..0000000 --- a/website/docs/api/node-git-server.httpduplex.setheader.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: node-git-server.httpduplex.setheader -hide_title: true -custom_edit_url: null -title: HttpDuplex.setHeader() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [setHeader](./node-git-server.httpduplex.setheader.md) - -## HttpDuplex.setHeader() method - -Signature: - -```typescript -setHeader(arg0: string, arg1: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| arg0 | string | | -| arg1 | string | | - -Returns: - -void diff --git a/website/docs/api/node-git-server.httpduplex.socket.md b/website/docs/api/node-git-server.httpduplex.socket.md deleted file mode 100644 index 3e09ea0..0000000 --- a/website/docs/api/node-git-server.httpduplex.socket.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.socket -hide_title: true -custom_edit_url: null -title: HttpDuplex.socket property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [socket](./node-git-server.httpduplex.socket.md) - -## HttpDuplex.socket property - -net.Socket object associated with the connection. - -Signature: - -```typescript -get socket(): import("net").Socket; -``` diff --git a/website/docs/api/node-git-server.httpduplex.statuscode.md b/website/docs/api/node-git-server.httpduplex.statuscode.md deleted file mode 100644 index 65fcc5a..0000000 --- a/website/docs/api/node-git-server.httpduplex.statuscode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: node-git-server.httpduplex.statuscode -hide_title: true -custom_edit_url: null -title: HttpDuplex.statusCode property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [statusCode](./node-git-server.httpduplex.statuscode.md) - -## HttpDuplex.statusCode property - -The HTTP status code. Generally assigned before sending headers for a response to a client. - -Signature: - -```typescript -get statusCode(): number; - -set statusCode(val: number); -``` - -## Example - -request.statusCode = 404; diff --git a/website/docs/api/node-git-server.httpduplex.statusmessage.md b/website/docs/api/node-git-server.httpduplex.statusmessage.md deleted file mode 100644 index 34e0f25..0000000 --- a/website/docs/api/node-git-server.httpduplex.statusmessage.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: node-git-server.httpduplex.statusmessage -hide_title: true -custom_edit_url: null -title: HttpDuplex.statusMessage property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [statusMessage](./node-git-server.httpduplex.statusmessage.md) - -## HttpDuplex.statusMessage property - -Controls the status message sent to the client as long as an explicit call to response.writeHead() isn't made If ignored or the value is undefined, the default message corresponding to the status code will be used. - -Signature: - -```typescript -get statusMessage(): string; - -set statusMessage(val: string); -``` - -## Example - -request.statusMessage = 'Document Not found'; diff --git a/website/docs/api/node-git-server.httpduplex.trailers.md b/website/docs/api/node-git-server.httpduplex.trailers.md deleted file mode 100644 index d541c1b..0000000 --- a/website/docs/api/node-git-server.httpduplex.trailers.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: node-git-server.httpduplex.trailers -hide_title: true -custom_edit_url: null -title: HttpDuplex.trailers property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [trailers](./node-git-server.httpduplex.trailers.md) - -## HttpDuplex.trailers property - -Request/response trailer headers. Just like except these are only written after the initial response to the client. This object is only populated at the 'end' event and only work if a 'transfer-encoding: chunked' header is sent in the initial response. - -Signature: - -```typescript -get trailers(): NodeJS.Dict\; -``` diff --git a/website/docs/api/node-git-server.httpduplex.uncork.md b/website/docs/api/node-git-server.httpduplex.uncork.md deleted file mode 100644 index 41b090c..0000000 --- a/website/docs/api/node-git-server.httpduplex.uncork.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: node-git-server.httpduplex.uncork -hide_title: true -custom_edit_url: null -title: HttpDuplex.uncork() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [uncork](./node-git-server.httpduplex.uncork.md) - -## HttpDuplex.uncork() method - -Flushes all data buffered since cork() was called. - -Signature: - -```typescript -uncork(): this; -``` - -Returns: - -this diff --git a/website/docs/api/node-git-server.httpduplex.url.md b/website/docs/api/node-git-server.httpduplex.url.md deleted file mode 100644 index 56e25b0..0000000 --- a/website/docs/api/node-git-server.httpduplex.url.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: node-git-server.httpduplex.url -hide_title: true -custom_edit_url: null -title: HttpDuplex.url property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [url](./node-git-server.httpduplex.url.md) - -## HttpDuplex.url property - -Request URL string. - -Signature: - -```typescript -get url(): string | undefined; -``` - -## Example 1 - -A request made as: GET /info?check=none HTTP/1.1 - -## Example 2 - -Will return the string '/info?check=none' diff --git a/website/docs/api/node-git-server.httpduplex.writable.md b/website/docs/api/node-git-server.httpduplex.writable.md deleted file mode 100644 index cef900a..0000000 --- a/website/docs/api/node-git-server.httpduplex.writable.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.httpduplex.writable -hide_title: true -custom_edit_url: null -title: HttpDuplex.writable property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [writable](./node-git-server.httpduplex.writable.md) - -## HttpDuplex.writable property - -Signature: - -```typescript -get writable(): boolean; -``` diff --git a/website/docs/api/node-git-server.httpduplex.writehead.md b/website/docs/api/node-git-server.httpduplex.writehead.md deleted file mode 100644 index f0f2055..0000000 --- a/website/docs/api/node-git-server.httpduplex.writehead.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: node-git-server.httpduplex.writehead -hide_title: true -custom_edit_url: null -title: HttpDuplex.writeHead() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [HttpDuplex](./node-git-server.httpduplex.md) > [writeHead](./node-git-server.httpduplex.writehead.md) - -## HttpDuplex.writeHead() method - -Sends a response header to the client request. Must only be called one time and before calling response.end(). - -Signature: - -```typescript -writeHead(statusCode: number, statusMessage: string, headers: string[]): this; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| statusCode | number | 3-digit HTTP status code, like 404 | -| statusMessage | string | An optional human readable status message to send with the status code | -| headers | string\[] | An object containing the response headers to send | - -Returns: - -this - -## Example - -var content = 'Under Construction...'; response.writeHead(200, { 'Content-Length': Buffer.byteLength(content), 'Content-Type': 'text/plain' }); response.end(content); diff --git a/website/docs/api/node-git-server.infodata.md b/website/docs/api/node-git-server.infodata.md deleted file mode 100644 index cdf19ac..0000000 --- a/website/docs/api/node-git-server.infodata.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: node-git-server.infodata -hide_title: true -custom_edit_url: null -title: InfoData interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [InfoData](./node-git-server.infodata.md) - -## InfoData interface - -an http duplex object (see below) with these extra properties - -Signature: - -```typescript -export interface InfoData extends HttpDuplex -``` - -**Extends:** [HttpDuplex](./node-git-server.httpduplex.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [repo](./node-git-server.infodata.repo.md) | string | | diff --git a/website/docs/api/node-git-server.infodata.repo.md b/website/docs/api/node-git-server.infodata.repo.md deleted file mode 100644 index 4014aa9..0000000 --- a/website/docs/api/node-git-server.infodata.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.infodata.repo -hide_title: true -custom_edit_url: null -title: InfoData.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [InfoData](./node-git-server.infodata.md) > [repo](./node-git-server.infodata.repo.md) - -## InfoData.repo property - -Signature: - -```typescript -repo: string; -``` diff --git a/website/docs/api/node-git-server.inforesponse.md b/website/docs/api/node-git-server.inforesponse.md deleted file mode 100644 index 9fc67cf..0000000 --- a/website/docs/api/node-git-server.inforesponse.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: node-git-server.inforesponse -hide_title: true -custom_edit_url: null -title: infoResponse() function ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [infoResponse](./node-git-server.inforesponse.md) - -## infoResponse() function - -sends http response using the appropriate output from service call - -Signature: - -```typescript -export declare function infoResponse(git: Git, repo: string, service: ServiceString, req: http.IncomingMessage, res: http.ServerResponse): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| git | [Git](./node-git-server.git.md) | an instance of git object | -| repo | string | the repository | -| service | [ServiceString](./node-git-server.servicestring.md) | the method that is responding infoResponse (push, pull, clone) | -| req | http.IncomingMessage | http request object | -| res | http.ServerResponse | http response | - -Returns: - -void diff --git a/website/docs/api/node-git-server.md b/website/docs/api/node-git-server.md deleted file mode 100644 index 2a80835..0000000 --- a/website/docs/api/node-git-server.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -id: node-git-server -hide_title: true -custom_edit_url: null -title: node-git-server package ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) - -## node-git-server package - -## Classes - -| Class | Description | -| --- | --- | -| [Git](./node-git-server.git.md) | | -| [HttpDuplex](./node-git-server.httpduplex.md) | | -| [Service](./node-git-server.service.md) | | - -## Functions - -| Function | Description | -| --- | --- | -| [basicAuth(req, res, callback)](./node-git-server.basicauth.md) | sets and parses basic auth headers if they exist | -| [createAction(opts, req, res)](./node-git-server.createaction.md) | responds with the correct service depending on the action | -| [infoResponse(git, repo, service, req, res)](./node-git-server.inforesponse.md) | sends http response using the appropriate output from service call | -| [noCache(res)](./node-git-server.nocache.md) | adds headers to the response object to add cache control | -| [packSideband(s)](./node-git-server.packsideband.md) | | -| [parseGitName(repo)](./node-git-server.parsegitname.md) | parses a git string and returns the repo name | -| [serviceRespond(dup, service, repoLocation, res)](./node-git-server.servicerespond.md) | execute given git operation and respond | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [FetchData](./node-git-server.fetchdata.md) | an http duplex object (see below) with these extra properties | -| [GitAuthenticateOptions](./node-git-server.gitauthenticateoptions.md) | | -| [GitEvents](./node-git-server.gitevents.md) | | -| [GitOptions](./node-git-server.gitoptions.md) | | -| [HeadData](./node-git-server.headdata.md) | an http duplex object (see below) with these extra properties | -| [InfoData](./node-git-server.infodata.md) | an http duplex object (see below) with these extra properties | -| [PushData](./node-git-server.pushdata.md) | Is a http duplex object (see below) with these extra properties | -| [ServiceOptions](./node-git-server.serviceoptions.md) | | -| [TagData](./node-git-server.tagdata.md) | An http duplex object (see below) with these extra properties: | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [ServiceString](./node-git-server.servicestring.md) | | diff --git a/website/docs/api/node-git-server.nocache.md b/website/docs/api/node-git-server.nocache.md deleted file mode 100644 index 8a3cf03..0000000 --- a/website/docs/api/node-git-server.nocache.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: node-git-server.nocache -hide_title: true -custom_edit_url: null -title: noCache() function ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [noCache](./node-git-server.nocache.md) - -## noCache() function - -adds headers to the response object to add cache control - -Signature: - -```typescript -export declare function noCache(res: http.ServerResponse): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| res | http.ServerResponse | http response | - -Returns: - -void diff --git a/website/docs/api/node-git-server.packsideband.md b/website/docs/api/node-git-server.packsideband.md deleted file mode 100644 index cf64966..0000000 --- a/website/docs/api/node-git-server.packsideband.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: node-git-server.packsideband -hide_title: true -custom_edit_url: null -title: packSideband() function ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [packSideband](./node-git-server.packsideband.md) - -## packSideband() function - -Signature: - -```typescript -export declare function packSideband(s: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| s | string | | - -Returns: - -string diff --git a/website/docs/api/node-git-server.parsegitname.md b/website/docs/api/node-git-server.parsegitname.md deleted file mode 100644 index 274789a..0000000 --- a/website/docs/api/node-git-server.parsegitname.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: node-git-server.parsegitname -hide_title: true -custom_edit_url: null -title: parseGitName() function ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [parseGitName](./node-git-server.parsegitname.md) - -## parseGitName() function - -parses a git string and returns the repo name - -Signature: - -```typescript -export declare function parseGitName(repo: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| repo | string | the raw repo name containing .git | - -Returns: - -string diff --git a/website/docs/api/node-git-server.pushdata.branch.md b/website/docs/api/node-git-server.pushdata.branch.md deleted file mode 100644 index 5be447e..0000000 --- a/website/docs/api/node-git-server.pushdata.branch.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.pushdata.branch -hide_title: true -custom_edit_url: null -title: PushData.branch property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [PushData](./node-git-server.pushdata.md) > [branch](./node-git-server.pushdata.branch.md) - -## PushData.branch property - -Signature: - -```typescript -branch: string; -``` diff --git a/website/docs/api/node-git-server.pushdata.commit.md b/website/docs/api/node-git-server.pushdata.commit.md deleted file mode 100644 index 3dbf019..0000000 --- a/website/docs/api/node-git-server.pushdata.commit.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.pushdata.commit -hide_title: true -custom_edit_url: null -title: PushData.commit property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [PushData](./node-git-server.pushdata.md) > [commit](./node-git-server.pushdata.commit.md) - -## PushData.commit property - -Signature: - -```typescript -commit: string; -``` diff --git a/website/docs/api/node-git-server.pushdata.md b/website/docs/api/node-git-server.pushdata.md deleted file mode 100644 index c0d34d5..0000000 --- a/website/docs/api/node-git-server.pushdata.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: node-git-server.pushdata -hide_title: true -custom_edit_url: null -title: PushData interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [PushData](./node-git-server.pushdata.md) - -## PushData interface - -Is a http duplex object (see below) with these extra properties - -Signature: - -```typescript -export interface PushData extends HttpDuplex -``` - -**Extends:** [HttpDuplex](./node-git-server.httpduplex.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [branch](./node-git-server.pushdata.branch.md) | string | | -| [commit](./node-git-server.pushdata.commit.md) | string | | -| [repo](./node-git-server.pushdata.repo.md) | string | | diff --git a/website/docs/api/node-git-server.pushdata.repo.md b/website/docs/api/node-git-server.pushdata.repo.md deleted file mode 100644 index cc584fa..0000000 --- a/website/docs/api/node-git-server.pushdata.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.pushdata.repo -hide_title: true -custom_edit_url: null -title: PushData.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [PushData](./node-git-server.pushdata.md) > [repo](./node-git-server.pushdata.repo.md) - -## PushData.repo property - -Signature: - -```typescript -repo: string; -``` diff --git a/website/docs/api/node-git-server.service._constructor_.md b/website/docs/api/node-git-server.service._constructor_.md deleted file mode 100644 index 817e98e..0000000 --- a/website/docs/api/node-git-server.service._constructor_.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: node-git-server.service._constructor_ -hide_title: true -custom_edit_url: null -title: Service.(constructor) ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [(constructor)](./node-git-server.service._constructor_.md) - -## Service.(constructor) - -Handles invoking the git-\*-pack binaries - -Signature: - -```typescript -constructor(opts: ServiceOptions, req: http.IncomingMessage, res: http.ServerResponse); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| opts | [ServiceOptions](./node-git-server.serviceoptions.md) | options to bootstrap the service object | -| req | http.IncomingMessage | http request object | -| res | http.ServerResponse | http response | diff --git a/website/docs/api/node-git-server.service.accept.md b/website/docs/api/node-git-server.service.accept.md deleted file mode 100644 index db1fc3d..0000000 --- a/website/docs/api/node-git-server.service.accept.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: node-git-server.service.accept -hide_title: true -custom_edit_url: null -title: Service.accept() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [accept](./node-git-server.service.accept.md) - -## Service.accept() method - -accepts request to access resource - -Signature: - -```typescript -accept(): void; -``` - -Returns: - -void diff --git a/website/docs/api/node-git-server.service.commit.md b/website/docs/api/node-git-server.service.commit.md deleted file mode 100644 index ebc5810..0000000 --- a/website/docs/api/node-git-server.service.commit.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.commit -hide_title: true -custom_edit_url: null -title: Service.commit property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [commit](./node-git-server.service.commit.md) - -## Service.commit property - -Signature: - -```typescript -commit: string | undefined; -``` diff --git a/website/docs/api/node-git-server.service.cwd.md b/website/docs/api/node-git-server.service.cwd.md deleted file mode 100644 index 58ed928..0000000 --- a/website/docs/api/node-git-server.service.cwd.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.cwd -hide_title: true -custom_edit_url: null -title: Service.cwd property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [cwd](./node-git-server.service.cwd.md) - -## Service.cwd property - -Signature: - -```typescript -cwd: string; -``` diff --git a/website/docs/api/node-git-server.service.evname.md b/website/docs/api/node-git-server.service.evname.md deleted file mode 100644 index 975d978..0000000 --- a/website/docs/api/node-git-server.service.evname.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.evname -hide_title: true -custom_edit_url: null -title: Service.evName property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [evName](./node-git-server.service.evname.md) - -## Service.evName property - -Signature: - -```typescript -evName: string | undefined; -``` diff --git a/website/docs/api/node-git-server.service.last.md b/website/docs/api/node-git-server.service.last.md deleted file mode 100644 index f5c493a..0000000 --- a/website/docs/api/node-git-server.service.last.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.last -hide_title: true -custom_edit_url: null -title: Service.last property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [last](./node-git-server.service.last.md) - -## Service.last property - -Signature: - -```typescript -last: string | undefined; -``` diff --git a/website/docs/api/node-git-server.service.log.md b/website/docs/api/node-git-server.service.log.md deleted file mode 100644 index d43a3d9..0000000 --- a/website/docs/api/node-git-server.service.log.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: node-git-server.service.log -hide_title: true -custom_edit_url: null -title: Service.log() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [log](./node-git-server.service.log.md) - -## Service.log() method - -Signature: - -```typescript -log(): void; -``` - -Returns: - -void diff --git a/website/docs/api/node-git-server.service.logs.md b/website/docs/api/node-git-server.service.logs.md deleted file mode 100644 index 3a5f275..0000000 --- a/website/docs/api/node-git-server.service.logs.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.logs -hide_title: true -custom_edit_url: null -title: Service.logs property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [logs](./node-git-server.service.logs.md) - -## Service.logs property - -Signature: - -```typescript -logs: string[]; -``` diff --git a/website/docs/api/node-git-server.service.md b/website/docs/api/node-git-server.service.md deleted file mode 100644 index 4ebcd15..0000000 --- a/website/docs/api/node-git-server.service.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: node-git-server.service -hide_title: true -custom_edit_url: null -title: Service class ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) - -## Service class - -Signature: - -```typescript -export declare class Service extends HttpDuplex -``` - -**Extends:** [HttpDuplex](./node-git-server.httpduplex.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(opts, req, res)](./node-git-server.service._constructor_.md) | | Handles invoking the git-\*-pack binaries | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [commit](./node-git-server.service.commit.md) | | string | undefined | | -| [cwd](./node-git-server.service.cwd.md) | | string | | -| [evName](./node-git-server.service.evname.md) | | string | undefined | | -| [last](./node-git-server.service.last.md) | | string | undefined | | -| [logs](./node-git-server.service.logs.md) | | string\[] | | -| [repo](./node-git-server.service.repo.md) | | string | | -| [service](./node-git-server.service.service.md) | | string | | -| [status](./node-git-server.service.status.md) | | string | | -| [username](./node-git-server.service.username.md) | | string | undefined | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [accept()](./node-git-server.service.accept.md) | | accepts request to access resource | -| [log()](./node-git-server.service.log.md) | | | -| [reject(code, msg)](./node-git-server.service.reject.md) | | reject request in flight | diff --git a/website/docs/api/node-git-server.service.reject.md b/website/docs/api/node-git-server.service.reject.md deleted file mode 100644 index f4db985..0000000 --- a/website/docs/api/node-git-server.service.reject.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -id: node-git-server.service.reject -hide_title: true -custom_edit_url: null -title: Service.reject() method ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [reject](./node-git-server.service.reject.md) - -## Service.reject() method - -reject request in flight - -Signature: - -```typescript -reject(code: number, msg: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| code | number | http response code | -| msg | string | message that should be displayed on the client | - -Returns: - -void diff --git a/website/docs/api/node-git-server.service.repo.md b/website/docs/api/node-git-server.service.repo.md deleted file mode 100644 index 04b0e5f..0000000 --- a/website/docs/api/node-git-server.service.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.repo -hide_title: true -custom_edit_url: null -title: Service.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [repo](./node-git-server.service.repo.md) - -## Service.repo property - -Signature: - -```typescript -repo: string; -``` diff --git a/website/docs/api/node-git-server.service.service.md b/website/docs/api/node-git-server.service.service.md deleted file mode 100644 index b0e45c4..0000000 --- a/website/docs/api/node-git-server.service.service.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.service -hide_title: true -custom_edit_url: null -title: Service.service property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [service](./node-git-server.service.service.md) - -## Service.service property - -Signature: - -```typescript -service: string; -``` diff --git a/website/docs/api/node-git-server.service.status.md b/website/docs/api/node-git-server.service.status.md deleted file mode 100644 index e3c577e..0000000 --- a/website/docs/api/node-git-server.service.status.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.status -hide_title: true -custom_edit_url: null -title: Service.status property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [status](./node-git-server.service.status.md) - -## Service.status property - -Signature: - -```typescript -status: string; -``` diff --git a/website/docs/api/node-git-server.service.username.md b/website/docs/api/node-git-server.service.username.md deleted file mode 100644 index 63654dc..0000000 --- a/website/docs/api/node-git-server.service.username.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.service.username -hide_title: true -custom_edit_url: null -title: Service.username property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [Service](./node-git-server.service.md) > [username](./node-git-server.service.username.md) - -## Service.username property - -Signature: - -```typescript -username: string | undefined; -``` diff --git a/website/docs/api/node-git-server.serviceoptions.cwd.md b/website/docs/api/node-git-server.serviceoptions.cwd.md deleted file mode 100644 index aaf10a6..0000000 --- a/website/docs/api/node-git-server.serviceoptions.cwd.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.serviceoptions.cwd -hide_title: true -custom_edit_url: null -title: ServiceOptions.cwd property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [ServiceOptions](./node-git-server.serviceoptions.md) > [cwd](./node-git-server.serviceoptions.cwd.md) - -## ServiceOptions.cwd property - -Signature: - -```typescript -cwd: string; -``` diff --git a/website/docs/api/node-git-server.serviceoptions.md b/website/docs/api/node-git-server.serviceoptions.md deleted file mode 100644 index 7f614f7..0000000 --- a/website/docs/api/node-git-server.serviceoptions.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: node-git-server.serviceoptions -hide_title: true -custom_edit_url: null -title: ServiceOptions interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [ServiceOptions](./node-git-server.serviceoptions.md) - -## ServiceOptions interface - -Signature: - -```typescript -export interface ServiceOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [cwd](./node-git-server.serviceoptions.cwd.md) | string | | -| [repo](./node-git-server.serviceoptions.repo.md) | string | | -| [service](./node-git-server.serviceoptions.service.md) | [ServiceString](./node-git-server.servicestring.md) | | diff --git a/website/docs/api/node-git-server.serviceoptions.repo.md b/website/docs/api/node-git-server.serviceoptions.repo.md deleted file mode 100644 index 6550715..0000000 --- a/website/docs/api/node-git-server.serviceoptions.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.serviceoptions.repo -hide_title: true -custom_edit_url: null -title: ServiceOptions.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [ServiceOptions](./node-git-server.serviceoptions.md) > [repo](./node-git-server.serviceoptions.repo.md) - -## ServiceOptions.repo property - -Signature: - -```typescript -repo: string; -``` diff --git a/website/docs/api/node-git-server.serviceoptions.service.md b/website/docs/api/node-git-server.serviceoptions.service.md deleted file mode 100644 index 93a3bdc..0000000 --- a/website/docs/api/node-git-server.serviceoptions.service.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.serviceoptions.service -hide_title: true -custom_edit_url: null -title: ServiceOptions.service property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [ServiceOptions](./node-git-server.serviceoptions.md) > [service](./node-git-server.serviceoptions.service.md) - -## ServiceOptions.service property - -Signature: - -```typescript -service: ServiceString; -``` diff --git a/website/docs/api/node-git-server.servicerespond.md b/website/docs/api/node-git-server.servicerespond.md deleted file mode 100644 index 7193565..0000000 --- a/website/docs/api/node-git-server.servicerespond.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: node-git-server.servicerespond -hide_title: true -custom_edit_url: null -title: serviceRespond() function ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [serviceRespond](./node-git-server.servicerespond.md) - -## serviceRespond() function - -execute given git operation and respond - -Signature: - -```typescript -export declare function serviceRespond(dup: HttpDuplex | Git, service: ServiceString, repoLocation: string, res: http.ServerResponse): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| dup | [HttpDuplex](./node-git-server.httpduplex.md) | [Git](./node-git-server.git.md) | duplex object to catch errors | -| service | [ServiceString](./node-git-server.servicestring.md) | the method that is responding infoResponse (push, pull, clone) | -| repoLocation | string | the repo path on disk | -| res | http.ServerResponse | http response | - -Returns: - -void diff --git a/website/docs/api/node-git-server.servicestring.md b/website/docs/api/node-git-server.servicestring.md deleted file mode 100644 index 450ee89..0000000 --- a/website/docs/api/node-git-server.servicestring.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.servicestring -hide_title: true -custom_edit_url: null -title: ServiceString type ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [ServiceString](./node-git-server.servicestring.md) - -## ServiceString type - -Signature: - -```typescript -export declare type ServiceString = 'upload-pack' | 'receive-pack'; -``` diff --git a/website/docs/api/node-git-server.tagdata.commit.md b/website/docs/api/node-git-server.tagdata.commit.md deleted file mode 100644 index 1813a55..0000000 --- a/website/docs/api/node-git-server.tagdata.commit.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.tagdata.commit -hide_title: true -custom_edit_url: null -title: TagData.commit property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [TagData](./node-git-server.tagdata.md) > [commit](./node-git-server.tagdata.commit.md) - -## TagData.commit property - -Signature: - -```typescript -commit: string; -``` diff --git a/website/docs/api/node-git-server.tagdata.md b/website/docs/api/node-git-server.tagdata.md deleted file mode 100644 index 744d6ad..0000000 --- a/website/docs/api/node-git-server.tagdata.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: node-git-server.tagdata -hide_title: true -custom_edit_url: null -title: TagData interface ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [TagData](./node-git-server.tagdata.md) - -## TagData interface - -An http duplex object (see below) with these extra properties: - -Signature: - -```typescript -export interface TagData extends HttpDuplex -``` - -**Extends:** [HttpDuplex](./node-git-server.httpduplex.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [commit](./node-git-server.tagdata.commit.md) | string | | -| [repo](./node-git-server.tagdata.repo.md) | string | | -| [version](./node-git-server.tagdata.version.md) | string | | diff --git a/website/docs/api/node-git-server.tagdata.repo.md b/website/docs/api/node-git-server.tagdata.repo.md deleted file mode 100644 index 1dc2e35..0000000 --- a/website/docs/api/node-git-server.tagdata.repo.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.tagdata.repo -hide_title: true -custom_edit_url: null -title: TagData.repo property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [TagData](./node-git-server.tagdata.md) > [repo](./node-git-server.tagdata.repo.md) - -## TagData.repo property - -Signature: - -```typescript -repo: string; -``` diff --git a/website/docs/api/node-git-server.tagdata.version.md b/website/docs/api/node-git-server.tagdata.version.md deleted file mode 100644 index 04bc11e..0000000 --- a/website/docs/api/node-git-server.tagdata.version.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: node-git-server.tagdata.version -hide_title: true -custom_edit_url: null -title: TagData.version property ---- - - - -[Home](./index.md) > [node-git-server](./node-git-server.md) > [TagData](./node-git-server.tagdata.md) > [version](./node-git-server.tagdata.version.md) - -## TagData.version property - -Signature: - -```typescript -version: string; -``` diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 5ace007..20502c8 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -3,6 +3,7 @@ // @ts-check // Note: type annotations allow type checking and IDEs autocompletion +const path = require('path'); const lightCodeTheme = require('prism-react-renderer/themes/github'); const darkCodeTheme = require('prism-react-renderer/themes/dracula'); @@ -22,9 +23,16 @@ const config = { require.resolve('docusaurus-plugin-search-local'), { highlightSearchTermsOnTargetPage: true, + docsRouteBasePath: ['docs', 'api'], + }, + ], + [ + 'docusaurus-plugin-typedoc-api', + { + projectRoot: path.join(__dirname, '..'), + packages: ['.'], }, ], - 'docusaurus-plugin-api-extractor', ], presets: [ [ @@ -32,7 +40,6 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { - sidebarPath: require.resolve('./sidebars.js'), editUrl: 'https://github.com/gabrielcsapo/node-git-server/edit/main/website/', }, @@ -65,10 +72,9 @@ const config = { label: 'Documentation', }, { - type: 'doc', - docId: 'api/index', - position: 'left', + to: 'api', label: 'API', + position: 'left', }, { href: 'https://github.com/gabrielcsapo/node-git-server', diff --git a/website/package.json b/website/package.json index 9d5548e..c285441 100644 --- a/website/package.json +++ b/website/package.json @@ -4,29 +4,23 @@ "private": true, "scripts": { "docusaurus": "docusaurus", - "api-extractor": "DOCUSAURUS_PLUGIN_API_EXTRACTOR_PROJECT_FOLDER_OVERRIDE=../ docusaurus api-extractor:run -s ./src -o api", - "start": "DOCUSAURUS_PLUGIN_API_EXTRACTOR_PROJECT_FOLDER_OVERRIDE=../ docusaurus start", - "lint": "echo 'none'", - "test": "echo 'none'", - "build": "DOCUSAURUS_PLUGIN_API_EXTRACTOR_PROJECT_FOLDER_OVERRIDE=../ docusaurus build", + "start": "docusaurus start", + "build": "docusaurus build", "swizzle": "docusaurus swizzle", - "deploy": "DOCUSAURUS_PLUGIN_API_EXTRACTOR_PROJECT_FOLDER_OVERRIDE=../ docusaurus deploy", + "deploy": "docusaurus deploy", "clear": "docusaurus clear", "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.22", - "@docusaurus/preset-classic": "2.0.0-beta.22", + "@docusaurus/core": "2.0.1", + "@docusaurus/preset-classic": "2.0.1", + "docusaurus-plugin-typedoc-api": "^2.3.0", "@mdx-js/react": "^1.6.21", "@svgr/webpack": "^5.5.0", "clsx": "^1.1.1", - "docusaurus-plugin-api-extractor": "^2.0.4", - "docusaurus-plugin-api-extractor-markdown-documenter": "0.3.4", - "docusaurus-plugin-search-local": "^0.7.0", - "@microsoft/api-extractor": "^7.28.4", - "@microsoft/api-documenter": "^7.18.2", + "docusaurus-plugin-search-local": "^0.8.2", "file-loader": "^6.2.0", "prism-react-renderer": "^1.2.1", "react": "^17.0.1", diff --git a/website/sidebars.js b/website/sidebars.js deleted file mode 100644 index cb10af7..0000000 --- a/website/sidebars.js +++ /dev/null @@ -1,20 +0,0 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - -// @ts-check - -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const sidebars = { - sidebar: [{ type: 'autogenerated', dirName: '.' }], -}; - -// eslint-disable-next-line no-undef -module.exports = sidebars; diff --git a/website/tsdoc-metadata.json b/website/tsdoc-metadata.json deleted file mode 100644 index 3e9671d..0000000 --- a/website/tsdoc-metadata.json +++ /dev/null @@ -1,11 +0,0 @@ -// This file is read by tools that parse documentation comments conforming to the TSDoc standard. -// It should be published with your NPM package. It should not be tracked by Git. -{ - "tsdocVersion": "0.12", - "toolPackages": [ - { - "packageName": "@microsoft/api-extractor", - "packageVersion": "7.19.4" - } - ] -}