Cloud API Overview > @adpt/cloud > docker > NetworkService
docker.NetworkService() function
Docker network service component, compatible with the abstract NetworkService component.
Signature:
export declare function NetworkService(props: SFCDeclProps<NetworkServiceProps, typeof defaultProps>): null;
Parameters
Parameter | Type | Description |
---|---|---|
props | SFCDeclProps< NetworkServiceProps , typeof defaultProps> |
Returns:
null
Remarks
Implements the NetworkServiceInstance interface. In a Docker deployment, there is no actual network service object to deploy. So this is a "virtual" component that simply implements the required instance methods for a NetworkService, but renders to null.
This component is typically used by docker.ServiceContainerSet. The docker.ServiceContainerSet component can be used to ensure the proper network port configuration is applied to the props.endpoint
container.