The library helps to make requests to YTsaurus platform backend over HTTP API.
npm install @ytsaurus/javascript-wrapper
const yt = require('@ytsaurus/javascript-wrapper')();
// The example show how to set global options for all commands.
// But if you need to communicate with several cluster then you have to provide proxy and token for each separate command.
yt.setup.setGlobalOption('proxy', 'plato.yt.my-domain.com');
yt.setup.setGlobalOption('secure', true);
yt.setup.setGlobalOption('authentication', {
type: 'domain',
});
yt.setup.setGlobalOption('timeout', 15000);
// Example 1
yt.v3.get({path: '//sys/users/yozhik/@'});
yt.v3
.get({
setup: {
proxy: 'hahn.yt.my-domain.com',
authentication: {
type: 'none',
},
},
parameters: {path: '//sys/users/yozhik/@'},
})
.done(function (userAttributes) {
// ...
});
// Example 2
yt.v3.set({path: '//sys/users/yozhik/@banned'}, true);
yt.v3
.set({
setup: {
proxy: 'banach.yt.my-domain.com',
authentication: {
type: 'oauth',
token: 'abcdefghijklmnopqrstuvwxyz',
},
},
parameters: {path: '//sys/users/yozhik/@banned'},
data: true,
})
.done(function () {
// ...
});The library allows to set global and local settings for each request.
| Option | type | Default value |
|---|---|---|
secure |
boolean | true |
useHeavyProxy |
boolean | - |
proxy |
string | - |
heavyProxy |
string | true |
timeout |
Number | 100000 |
useEncodedParameters |
boolean | true |
authentication |
object | { type: 'none' } |
dataType |
string | - |
encodedParametersSettings |
object |
{
maxSize: 64 * 1024,
maxCount: 2,
encoder(string) {
return window.btoa(utf8.encode(string));
}
}
There is ability to subscribe for events: requestStart, requestEnd, error
yt.subsribe('requestStart', function () {
console.log('requestStart');
});
It might be useful if you need to show the presence of active requests or if you need to log some error.
Available commands might be found at https://ytsaurus.tech/docs/en/api/commands, but all the commands should be written in camelCase:
If you don't need to override local configuration options you can use syntax:
// yt.<version>.<command>(<parameters>[, <data>])
yt.v3.get({path: '//home/user/@account'});
yt.v3.set({path: '//home/user/@account'}, 'default');also there is ability to define options by setup field:
/**
* yt.<version>.<command>({
* parameters: <parameters>,
* data: <data>,
* setup: <setup>
* })
*/
const setup = {timeout: 3000};
yt.v3.get({setup, parameters: {path: '//home/user/@account'}});
yt.v3.set({setup, parameters: {path: '//home/user/@account'}}, 'default');| Error name | Code |
|---|---|
yt.codes.GENERAL_ERROR |
1 |
yt.codes.NODE_DOES_NOT_EXIST |
500 |
yt.codes.NODE_ALREADY_EXISTS |
501 |
yt.codes.PERMISSION_DENIED |
901 |
yt.codes.USER_IS_BANNED |
903 |
yt.codes.USER_EXCEEDED_RPS |
904 |