@cedx/free-mobile
Advanced tools
Comparing version 15.0.1 to 15.1.0
/** | ||
* Sends messages by SMS to a [FreeMobile](https://mobile.free.fr) account. | ||
*/ | ||
export class Client { | ||
export declare class Client { | ||
/** | ||
* Creates a new client. | ||
* @param {string} account The Free Mobile account. | ||
* @param {string} apiKey The Free Mobile API key. | ||
* @param {string} [baseUrl] The base URL of the remote API endpoint. | ||
*/ | ||
constructor(account: string, apiKey: string, baseUrl?: string | undefined); | ||
/** | ||
* The Free Mobile account. | ||
* @type {string} | ||
* @readonly | ||
*/ | ||
@@ -20,4 +11,2 @@ readonly account: string; | ||
* The Free Mobile API key. | ||
* @type {string} | ||
* @readonly | ||
*/ | ||
@@ -27,13 +16,18 @@ readonly apiKey: string; | ||
* The base URL of the remote API endpoint. | ||
* @type {URL} | ||
* @readonly | ||
*/ | ||
readonly baseUrl: URL; | ||
/** | ||
* Sends a SMS message to the underlying account. | ||
* @param {string} message The message text. | ||
* @returns {Promise<void>} Resolves when the message has been sent. | ||
* Creates a new client. | ||
* @param account The Free Mobile account. | ||
* @param apiKey The Free Mobile API key. | ||
* @param baseUrl The base URL of the remote API endpoint. | ||
*/ | ||
constructor(account: string, apiKey: string, baseUrl?: string); | ||
/** | ||
* Sends an SMS message to the underlying account. | ||
* @param message The message text. | ||
* @returns Resolves when the message has been sent. | ||
*/ | ||
sendMessage(message: string): Promise<void>; | ||
} | ||
//# sourceMappingURL=client.d.ts.map |
export * from "./client.js"; | ||
//# sourceMappingURL=index.d.ts.map |
# MIT License | ||
Copyright © 2016-2022 Cédric Belin | ||
Copyright (c) Cédric Belin | ||
@@ -4,0 +4,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy |
@@ -7,5 +7,5 @@ { | ||
"name": "@cedx/free-mobile", | ||
"repository": "github:cedx/free-mobile.js", | ||
"repository": "cedx/free-mobile.js", | ||
"type": "module", | ||
"version": "15.0.1", | ||
"version": "15.1.0", | ||
"author": { | ||
@@ -17,20 +17,15 @@ "email": "cedric@belin.io", | ||
"devDependencies": { | ||
"@babel/eslint-parser": "^7.19.1", | ||
"@babel/plugin-syntax-import-assertions": "^7.18.6", | ||
"@types/gulp": "^4.0.9", | ||
"@types/node": "^18.11.0", | ||
"c8": "^7.12.0", | ||
"del": "^7.0.0", | ||
"eslint": "^8.25.0", | ||
"execa": "^6.1.0", | ||
"gulp": "^4.0.2", | ||
"typedoc": "^0.23.17", | ||
"typescript": "^4.8.4" | ||
"@types/node": "^20.11.6", | ||
"@typescript-eslint/eslint-plugin": "^6.19.1", | ||
"@typescript-eslint/parser": "^6.19.1", | ||
"eslint": "^8.56.0", | ||
"typedoc": "^0.25.7", | ||
"typescript": "^5.3.3" | ||
}, | ||
"engines": { | ||
"node": ">=18.0.0" | ||
"node": ">=20.0.0" | ||
}, | ||
"exports": { | ||
"types": "./lib/index.d.ts", | ||
"import": "./src/index.js" | ||
"import": "./lib/index.js" | ||
}, | ||
@@ -41,2 +36,8 @@ "files": [ | ||
], | ||
"imports": { | ||
"#freeMobile": { | ||
"types": "./lib/index.d.ts", | ||
"import": "./lib/index.js" | ||
} | ||
}, | ||
"keywords": [ | ||
@@ -50,5 +51,11 @@ "api", | ||
"scripts": { | ||
"prepack": "gulp", | ||
"test": "c8 --all --include=src/**/*.js --report-dir=var --reporter=lcovonly node --test" | ||
"build": "tsc --project src/tsconfig.json", | ||
"clean": "node tool/clean.js", | ||
"doc": "typedoc --options etc/typedoc.js && node tool/doc.js", | ||
"dist": "npm run clean && npm run build", | ||
"lint": "tsc --project tsconfig.json && eslint --config=etc/eslint.cjs example src test tool", | ||
"postpublish": "node tool/publish.js", | ||
"prepack": "npm run dist", | ||
"test": "npm run build && node --test --test-reporter=spec" | ||
} | ||
} |
# Free Mobile for JS | ||
![Runtime](https://badgen.net/npm/node/@cedx/free-mobile) ![Release](https://badgen.net/npm/v/@cedx/free-mobile) ![License](https://badgen.net/npm/license/@cedx/free-mobile) ![Downloads](https://badgen.net/npm/dt/@cedx/free-mobile) ![Coverage](https://badgen.net/codecov/c/github/cedx/free-mobile.js) | ||
![Node.js](https://badgen.net/npm/node/@cedx/free-mobile) ![npm](https://badgen.net/npm/v/@cedx/free-mobile) ![License](https://badgen.net/npm/license/@cedx/free-mobile) ![Downloads](https://badgen.net/npm/dt/@cedx/free-mobile) | ||
@@ -8,4 +8,4 @@ Send SMS messages to your [Free Mobile](https://mobile.free.fr) account, | ||
## Documentation | ||
- [User guide](https://github.com/cedx/free-mobile.js/wiki) | ||
- [API reference](https://cedx.github.io/free-mobile.js) | ||
- [User guide](https://cedx.github.io/free-mobile.js) | ||
- [API reference](https://cedx.github.io/free-mobile.js/api) | ||
@@ -12,0 +12,0 @@ ## Development |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
8019
6
12
132