https://github.com/prowriting/prowritingaid.typescript
Official Typescript SDK. Grammar checking API for Typescript. Also includes: style improvements, terminology checking, and plagiarism checking API.
https://github.com/prowriting/prowritingaid.typescript
api grammar prowriting prowritingaid sdk style typescript writing
Last synced: 6 months ago
JSON representation
Official Typescript SDK. Grammar checking API for Typescript. Also includes: style improvements, terminology checking, and plagiarism checking API.
- Host: GitHub
- URL: https://github.com/prowriting/prowritingaid.typescript
- Owner: prowriting
- License: apache-2.0
- Created: 2017-07-12T15:31:41.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-05-06T13:17:19.000Z (about 5 years ago)
- Last Synced: 2025-10-06T12:50:31.749Z (9 months ago)
- Topics: api, grammar, prowriting, prowritingaid, sdk, style, typescript, writing
- Language: TypeScript
- Homepage: https://prowritingaid.com/en/App/Api
- Size: 95.7 KB
- Stars: 9
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ProWritingAid.API
Official typescript [prowritingaid.com](https://prowritingaid.com) API.
- API version: v2
- Package version: v2.0.0
For more information, please visit [https://prowritingaid.com/en/App/API#ts](https://prowritingaid.com/en/App/API#ts)
## Installation
### For [Node.js](https://nodejs.org/)
#### npm
Install package using command:
```shell
npm install pro_writing_aid_ts --save
```
#### git
#
Or install package from the git repo:
```shell
npm install prowriting/prowritingaid.typescript --save
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following TS code:
```typescript
import PWA = require('pro_writing_aid_ts');
let api = new PWA.HtmlApi();
api.setApiKey(PWA.ApiKeys.licenseCode, '$Your license code$');
let request = new PWA.HtmlAnalysisRequest();
request.Html = 'I\'d like to by that toy. wood you help me? I have twp more brothers.';
request.Reports = ['grammar'];
request.Language = PWA.LanguageEnum.En;
request.Style = PWA.StyleEnum.General;
api.post(request)
.then(function (data) {
console.log('API called successfully. Returned data: ');
console.log(data.Body);
}, function (error) {
console.error(error);
})
/* Example of what you will get
API called successfully. Returned data:
{ Html: 'I\'d like to by that toy. wood you help me? I have twp more brothers.',
WordCount: 16,
Summaries:
[ { ReportDisplayName: 'Grammar Check',
ReportName: 'grammar',
SummaryItems: [Object],
NumberOfIssues: 2,
ReportDescription: 'Checks your text for grammar errors and potential word mis-use.' } ] }
*/
```
## Documentation for API Classes
All URIs are relative to *https://api.prowritingaid.com*
Class | Method | Description
------------ | ------------- | -------------
*ContextualThesaurusApi* | [**Post**](docs/ContextualThesaurusApi.md#Post) |
*HtmlApi* | [**Post**](docs/HtmlApi.md#Post) |
*SummaryApi* | [**Post**](docs/SummaryApi.md#Post) |
*TextApi* | [**Post**](docs/TextApi.md#Post) |
*WordCloudApi* | [**Post**](docs/WordCloudApi.md#Post) |
## Documentation for Models
- [AnalysisSettings](docs/AnalysisSettings.md)
- [AnalysisSummary](docs/AnalysisSummary.md)
- [AnalysisSummaryGraph](docs/AnalysisSummaryGraph.md)
- [AnalysisSummaryGraphItem](docs/AnalysisSummaryGraphItem.md)
- [AnalysisSummaryItem](docs/AnalysisSummaryItem.md)
- [AnalysisSummarySubItem](docs/AnalysisSummarySubItem.md)
- [ContextualThesaurusRequest](docs/ContextualThesaurusRequest.md)
- [ContextualThesaurusResponse](docs/ContextualThesaurusResponse.md)
- [DocTag](docs/DocTag.md)
- [HtmlAnalysisRequest](docs/HtmlAnalysisRequest.md)
- [HtmlAnalysisResponse](docs/HtmlAnalysisResponse.md)
- [HttpResponse](docs/HttpResponse.md)
- [SuggestionCategory](docs/SuggestionCategory.md)
- [SummaryAnalysisRequest](docs/SummaryAnalysisRequest.md)
- [SummaryAnalysisResponse](docs/SummaryAnalysisResponse.md)
- [TextAnalysisRequest](docs/TextAnalysisRequest.md)
- [TextAnalysisResponse](docs/TextAnalysisResponse.md)
- [WordCloudRequest](docs/WordCloudRequest.md)
- [WordCloudResponse](docs/WordCloudResponse.md)
## Documentation for Authorization
### licenseCode
- **Type**: API key
- **API key parameter name**: licenseCode
- **Location**: HTTP header