@heycharles/browser-sdk
Advanced tools
The browser utility for working with the Charles API.
# Run npm install and write your library name when asked. That's all!
npm install @heycharles/browser-sdk
You can import the generated bundle to use the whole library generated by this starter:
import * as charles from '@heycharles/browser-sdk'
// configure which API to use. E.g. you can also run staging and sandbox APIs
charles.init({
universe: 'https://my-universe.hello-charles.com'
})
// use any authentication method that .auth provides
charles.auth.loginUsername({ username: 'client_account@client.com', password: 'xxxxxxxxxxx' })
// or when already authenticated and rehydrating state you can immediately also hydrated an
// authenticated th client
charles.init({
universe: 'https://my-universe.hello-charles.com',
credentials: {
token: window.localStorage.getItem('charles-token')
},
user: window.localStorage.getItem('charles-user-uuid')
})
Additionally, you can import the transpiled modules from dist/lib in case you have a modular library:
import Auth from '@heycharles/browser-sdk/dist/lib/Auth'
npm t: Runs test suite.npm start: Run npm run build in watch modenpm run test:watch: Run test suite in interactive watch modenpm run test:prod: Run linting and generate coveragenpm run build: Generate bundles and typings, create docsnpm run lint: Lints codenpm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)Apache-2.0
FAQs
The Browser SDK for the Charles APIs.
The npm package @heycharles/browser-sdk receives a total of 967 weekly downloads. As such, @heycharles/browser-sdk popularity was classified as not popular.
We found that @heycharles/browser-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.