adobe / aem-headless-client-js

AEM Headless Client for JavaScript
Apache License 2.0
25 stars 12 forks source link

Feature/12 rename methods #17

Closed easingthemes closed 3 years ago

easingthemes commented 3 years ago

Description

Methods renamed:

new AEMHeadless(config) .runQuery(query, [options]) ⇒ Promise. .persistQuery(query, path, [options]) ⇒ Promise. .listPersistedQueries([options]) ⇒ Promise. .runPersistedQuery(path, [options]) ⇒ Promise.

Constructor updated:

new AEMHeadless(config)

Constructor. If param is a string, it's treated as AEM server URL, default GraphQL endpoint is used. For granular params, use config object

Param | Type | Description -- | -- | -- config | object \| string | Configuration object, or AEM server URL string [config.serviceURL] | string | AEM server URL [config.endpoint] | string | GraphQL endpoint [config.auth] | string \| Array | Bearer token string or [user,pass] pair array


## Related Issue https://github.com/adobe/aem-headless-client-js/issues/12 ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: - [x] I have signed the [Adobe Open Source CLA](http://opensource.adobe.com/cla.html). - [x] My code follows the code style of this project. - [x] My change requires a change to the documentation. - [x] I have updated the documentation accordingly. - [x] I have read the **CONTRIBUTING** document. - [x] I have added tests to cover my changes. - [x] All new and existing tests passed.
bdelacretaz commented 3 years ago

Looks good to me as well