fix(readme): add links to documentation

This commit is contained in:
Philipp Kunz 2019-11-18 16:18:58 +00:00
parent a602155d0b
commit 340287ea55
7 changed files with 1947 additions and 120 deletions

2030
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -15,12 +15,14 @@
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.0.22", "@gitzone/tsbuild": "^2.0.22",
"@gitzone/tstest": "^1.0.15", "@gitzone/tstest": "^1.0.15",
"@pushrocks/qenv": "^4.0.6",
"@pushrocks/tapbundle": "^3.0.7", "@pushrocks/tapbundle": "^3.0.7",
"@types/node": "^10.11.7", "@types/node": "^10.11.7",
"tslint": "^5.11.0", "tslint": "^5.11.0",
"tslint-config-prettier": "^1.15.0" "tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartletter": "^1.0.10",
"@pushrocks/smartrequest": "^1.1.42" "@pushrocks/smartrequest": "^1.1.42"
}, },
"files": [ "files": [

3
qenv.yml Normal file
View File

@ -0,0 +1,3 @@
required:
- API_EMAIL
- API_TOKEN

View File

@ -18,6 +18,9 @@ an unofficial API package for the letterxpress API
## Usage ## Usage
Use TypeScript for best in class intellisense.
letterxpress implements the LXP API documented here: [LXP API Documentation](https://www.letterxpress.de/briefe-uebertragen/api)
## Contribution ## Contribution

View File

@ -1,10 +1,16 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import * as letterxpress from '../ts/index'; import * as letterxpress from '../ts/index';
import { Qenv } from '@pushrocks/qenv';
let testQenv = new Qenv('./', './.nogit/');
let testAccount: letterxpress.LetterXpressAccount; let testAccount: letterxpress.LetterXpressAccount;
tap.test('should create a valid account', async () => { tap.test('should create a valid account', async () => {
testAccount = new letterxpress.LetterXpressAccount(); testAccount = new letterxpress.LetterXpressAccount({
apiKey: testQenv.getEnvVarOnDemand('API_TOKEN'),
email: testQenv.getEnvVarOnDemand('API_EMAIL')
});
expect(testAccount).to.be.instanceOf(letterxpress.LetterXpressAccount); expect(testAccount).to.be.instanceOf(letterxpress.LetterXpressAccount);
}); });

View File

@ -1,5 +1,16 @@
import * as plugins from './letterxpress.plugins'; import * as plugins from './letterxpress.plugins';
export class LetterXpressAccount { export interface ILetterXpressConstructorOptions {
email: string;
apiKey: string;
}
export class LetterXpressAccount {
public options: ILetterXpressConstructorOptions;
constructor(optionsArg: ILetterXpressConstructorOptions) {
this.options = optionsArg;
}
public request() {}
} }

View File

@ -1,5 +1,3 @@
import * as smartrequest from '@pushrocks/smartrequest'; import * as smartrequest from '@pushrocks/smartrequest';
export { export { smartrequest };
smartrequest
};