Single File Content
vcs/single-file-content@1.1.13 providers
Single File Content
Get the content of the specified file.
Input
Owner
Repo
Path
Ref
Result
Size
Content
Encoding
1.Choose a provider
2.Use SingleFileContent with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Copied!
const { SuperfaceClient } = require('@superfaceai/one-sdk');
// You can manage tokens here: https://superface.ai/insights
const sdk = new SuperfaceClient({ sdkAuthToken: '<< Login to get your token >>' });
async function run() {
// Load the profile
const profile = await sdk.getProfile('vcs/single-file-content@1.1.1');
// Use the profile
const result = await profile
.getUseCase('SingleFileContent')
.perform({
owner: 'superfaceai',
repo: 'one-sdk-js',
path: '/README.md',
ref: 'c5e4d76'
}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Input (object)
owner
required
Owner of the repository
string
repo
required
Repository name
string
path
required
Path to file at repository
string
ref
required
Branch eg. main
string
Example
{
"owner": "superfaceai",
"repo": "one-sdk-js",
"path": "/README.md",
"ref": "c5e4d76"
}Copied!
Result (object)
size
required
Size of content according to used provider
number
content
required
Content of file
string
encoding
required
Used encoding
string
Example
{
"size": 5,
"content": "0.a4ba399d443d3",
"encoding": "base64"
}Copied!